A modern, production-ready React template with TypeScript, Tailwind CSS, and more.
- ⚡️ Vite - Lightning fast build tool
- ⚛️ React 18 - UI library
- 📘 TypeScript - Type safety
- 🎨 Tailwind CSS - Utility-first CSS framework
- 🔄 React Query - Data fetching and caching
- 📦 Valtio - State management
- 🛠️ ESLint - Code linting
- 💅 Prettier - Code formatting
- 🐶 Husky - Git hooks
- 🧪 Vitest - Unit testing
- Node.js >= 20
- pnpm >= 8
-
Clone the repository:
git clone https://github.com/your-username/reactjs-template.git cd reactjs-template
-
Install dependencies:
pnpm install
-
Start development server:
pnpm dev
-
Build for production:
pnpm build
pnpm dev
- Start development serverpnpm build
- Build for productionpnpm preview
- Preview production buildpnpm test
- Run testspnpm lint
- Run linterpnpm format
- Format code with Prettierpnpm tsc
- Type check TypeScript files
src/
├── features/ # Feature-based components and logic
├── shared/ # Shared components and utilities
├── services/ # API and external service integrations
├── libs/ # Third-party library integrations
├── config/ # Configuration files
└── styles/ # Global styles and theme
Create a .env
file in the root directory based on .env.template
:
VITE_API_URL=your_api_url
VITE_APP_NAME=your_app_name
Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
This project is licensed under the MIT License - see the LICENSE file for details.