Skip to content

khanhnm222/react-atomic-design

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

React + TypeScript + Vite + Atomic Design + TailwindCSS v4 Template

πŸš€ A modern boilerplate for building scalable React applications with Vite, TypeScript, Atomic Design principles, and TailwindCSS v4.
This template provides a clean structure, utility-first styling with the latest Tailwind features, and best practices for reusable UI components.


✨ Features

  • ⚑ Vite β€” Blazing-fast dev server & build
  • πŸ›‘ TypeScript β€” Strong typing for maintainability
  • 🧩 Atomic Design β€” Scalable UI architecture
  • 🎨 TailwindCSS v4 β€” Zero-config, utility-first styling
  • βœ… Pre-configured ESLint & Prettier

πŸ“‚ Project Structure

src/
β”œβ”€β”€ assets/         # Static assets (images, fonts, etc.)
β”œβ”€β”€ components/     # Atomic Design layers
β”‚   β”œβ”€β”€ atoms/      # Smallest building blocks (buttons, inputs, labels)
β”‚   β”œβ”€β”€ molecules/  # Groups of atoms (form fields, cards)
β”‚   β”œβ”€β”€ organisms/  # Complex UI sections (headers, navbars, sidebars)
β”‚   β”œβ”€β”€ templates/  # Page-level layouts
β”‚   └── pages/      # Route-level views
β”œβ”€β”€ hooks/          # Custom React hooks
β”œβ”€β”€ utils/          # Utility functions & helpers
β”œβ”€β”€ models/          # TypeScript model definitions
β”œβ”€β”€ App.tsx         # Root component
└── main.tsx        # Application entry

πŸš€ Getting Started

1. Clone the repository

git clone https://github.com/khanhnm222/react-atomic-design.git
cd react-atomic-design

2. Install dependencies

npm install
# or
yarn install

3. Start development server

npm run dev
# or
yarn dev

Your app will be running at: http://localhost:5173

πŸ“¦ Available Scripts

  • npm run dev β€” Start development server with HMR

  • npm run build β€” Build the app for production

  • npm run preview β€” Preview production build locally

  • npm run lint β€” Run ESLint checks

🧩 Atomic Design Overview

  • Atoms β†’ Small, independent UI components (e.g., Button, Input).

  • Molecules β†’ Groups of atoms working together (e.g., FormField).

  • Organisms β†’ Complex UI sections combining molecules (e.g., Header, CardList).

  • Templates β†’ Page-level layouts with placeholders.

  • Pages β†’ Final screens composed of templates & organisms.

πŸ“– Tech Stack

  • React β€” UI Library

  • Vite β€” Next-gen frontend tooling

  • TypeScript β€” Static typing

  • TailwindCSS v4 β€” Utility-first styling (zero config)

  • ESLint & Prettier β€” Code quality & formatting

πŸ“ License

This project is licensed under the MIT License. Feel free to use, modify, and share it in your own projects.

πŸ™Œ Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you’d like to change.

About

πŸš€ React + TypeScript + Vite + Atomic Design Template A modern boilerplate for building scalable React applications with Vite, TypeScript, and Atomic Design principles. Includes a clean project structure, fast development environment, and best practices for maintainable UI components.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors