UNPKG

vt-tw

Version:

A fully initialized React Vite + Tailwind CSS starter template to kickstart modern front-end projects. This package provides an optimized and minimal boilerplate with fast development, zero-config setup, and best practices.

113 lines (80 loc) 2.17 kB
--- # **VT-TW: React + Vite + Tailwind Starter** 🚀 **VT-TW** is a fully initialized **React Vite + Tailwind CSS** starter template, designed for modern front-end projects. It offers **fast development**, **zero-config setup**, and **best practices** to kickstart your next project effortlessly. <p align="center"> <img src="./mockup.gif" alt="mockup-image" /> </p> --- ## **✨ Features** **React 19 + Vite** Lightning-fast development **Tailwind CSS** Utility-first styling **ESLint & Prettier** Clean and consistent code **React Router** Pre-configured for navigation **Zero Config Setup** Just install and start coding --- ## **📦 Installation** ### **Using npx (Recommended)** ```sh npx vt-tw ``` _This will prompt you to enter your project name._ ### **Using npm** ```sh npm i vt-tw ``` _Then, run:_ ```sh npx create-vt-tw <your-project-name> ``` --- ## **🚀 Usage** After creating your project: ```sh cd <your-project-name> npm install npm run dev ``` --- ## **📂 Folder Structure** ``` your-project/ ├── src/ # React components & pages ├── public/ # Static assets ├── tailwind.config.js # Tailwind CSS config ├── vite.config.js # Vite config ├── package.json # Project metadata └── README.md # Documentation ``` --- ## **⚡ Development** To start the development server: ```sh npm run dev ``` To build for production: ```sh npm run build ``` To preview the build: ```sh npm run preview ``` To format and lint the code: ```sh npm run lint ``` --- ## **📖 Learn More** - [Vite Documentation](https://vitejs.dev/) - [React Documentation](https://react.dev/) - [Tailwind CSS Documentation](https://tailwindcss.com/) --- ## **👨‍💻 Author** **Thinakaran Manokaran** 🚀 GitHub: [@thinakaranmanokaran](https://github.com/thinakaranmanokaran) Portfolio: [Thinakaran Manokaran](https://thinakaranmanokaran.netlify.app) --- ## **📜 License** This project is licensed under the **MIT License**. 🚀 Happy Coding! **Enjoy Code!** 😎🎉 ---