This project is a boilerplate based on React, integrating Vite, TypeScript, React Router, ESLint, Prettier, and Tailwind CSS to provide a modern web development environment.
- React 18: Utilizes the latest version of React.
- Vite: Offers fast build time and HMR (Hot Module Replacement).
- TypeScript: Enhances type safety and development efficiency.
- React Router v6: A powerful solution for SPA routing.
- Redux Toolkit: Simplifies store setup and reduces boilerplate code.
- ESLint & Prettier: Ensures code quality and consistency.
- Tailwind CSS: Uses a utility-first CSS framework for styling.
This project uses pnpm for efficient and fast package management. The pnpm-lock.yaml file ensures consistent installation of dependencies across environments, locking the versions of all packages the project depends on.
Follow these steps to use this project.
- If you don't have pnpm installed, install it globally:
npm install -g pnpm
- Clone or download the repository.
git clone https://github.com/your-username/pnpm-react-boilerplate.git
- Move into the project directory.
cd pnpm-react-boilerplate
- Install the necessary packages.
pnpm install
To run the application in development mode, use:
pnpm start
This command starts the development server, and the application will be available at http://localhost:3000.
To create a production build, use:
pnpm build
- Lint: Finds and fixes problems in your code with ESLint.
pnpm lint
- Format: Formats your code using Prettier.
pnpm format
This project is distributed under the MIT License. This README.md provides essential information and instructions for using the project. Feel free to add additional sections or modify the content as needed, such as a more detailed project description, contribution guidelines, code examples, etc.