This is a boilerplate project that combines Vite, ReactJS, and TailwindCSS to kickstart your web development projects. Vite is a fast development build tool, ReactJS is a popular JavaScript library for building user interfaces, and TailwindCSS is a utility-first CSS framework.
Live Demo[https://boilerplate-nu.vercel.app]
✨ Vite A build tool that provides a fast and optimized development experience.
⚛️ ReactJS A JavaScript library for building reusable UI components.
🎨 TailwindCSS A utility-first CSS framework that enables rapid UI development.
🔧 PostCSS A tool for transforming CSS with JavaScript plugins.
🚦 ESLint A pluggable JavaScript linter for identifying and reporting code quality issues.
🔍 Prettier An opinionated code formatter that maintains consistent code style.
Make sure you have the following installed on your machine:
Node.js (v14 or above)
npm or Yarn
- Clone the repository:
git clone https://github.com/AyanDas348/boilerplate.git
- Navigate into the project directory:
cd boilerplate
- Install the dependencies using npm or Yarn:
# Using npm
npm install
# Using Yarn
yarn install
- Start the development server:
# Using npm
npm run dev
# Using Yarn
yarn dev
- Open your browser and visit http://localhost:5173 to see the app running.
To build the application for production, run the following command:
# Using npm
npm run build
# Using Yarn
yarn build
The optimized and minified assets will be generated in the dist directory.
To format the code using Prettier, run the following command:
# Using npm
npm run format
# Using Yarn
yarn format
To lint the code using ESLint, run the following command:
# Using npm
npm run lint
# Using Yarn
yarn lint
Feel free to customize the configuration files and project structure according to your needs. Here are some key files and directories to get started:
- src: Contains the main source code files.
- public: Contains static assets that will be served as-is.
- vite.config.js: Configuration file for Vite.
- postcss.config.js: Configuration file for PostCSS.
- .eslintrc.js: ESLint configuration file.
- .prettierrc: Prettier configuration file.
- jest.config.js: Jest configuration file.
Contributions are welcome! If you find any issues or have suggestions for improvements, please create an issue or submit a pull request.
This project is licensed under the MIT license.