This project is a modern React application template set up with TypeScript, Vite, ShadCN, Tailwind CSS, and PNPM for efficient and scalable development.
- React: A JavaScript library for building user interfaces.
- TypeScript: Provides static typing for better code quality and development experience.
- Vite: A fast and lightweight build tool for modern web development.
- ShadCN: UI components based on Radix for accessible and customizable design.
- Tailwind CSS: Utility-first CSS framework for rapidly building custom designs.
- PNPM: Fast and disk space-efficient package manager.
Ensure you have the following installed:
-
Clone the Repository
git clone <repository-url> cd <project-folder>
-
Install Dependencies
Run the following command to install the project dependencies:
pnpm install
-
Start the Development Server
Launch the application in development mode with:
pnpm dev
Open your browser and navigate to
http://localhost:5173to view the app. -
Build for Production
Create an optimized production build:
pnpm build
The build files will be located in the
distfolder. -
Preview Production Build
Preview the production build locally:
pnpm preview
-
ShadCN Components: Visit the ShadCN Documentation to explore available components and customize them as per your requirements.
-
Tailwind CSS: Modify the
tailwind.config.jsfile to adjust the theme or extend utilities.
Here are some useful scripts:
pnpm dev: Start the development server.pnpm build: Build the application for production.pnpm preview: Preview the production build.pnpm lint: Run linters to check code quality.
Feel free to submit issues and pull requests to contribute to the project.
This project is licensed under the MIT License.