Skip to content

README.md

Latest commit

 

History

History
92 lines (64 loc) · 2.13 KB

README.md

File metadata and controls

92 lines (64 loc) · 2.13 KB

🚀 create-rvst

A modern CLI tool to scaffold a new RVST-Stack project using Vite, React, Shadcn UI, and Tailwind CSS.

🌟 Features

  • ⚡ Vite - Lightning-fast build tool and dev server
  • ⚛️ React - Popular UI library for building user interfaces
  • 🎨 Shadcn UI - High-quality, accessible component system
  • 🌊 Tailwind CSS - Utility-first CSS framework
  • 🔥 Hot Module Replacement (HMR) - Instant feedback during development
  • 🧪 ESLint - Code linting for best practices

📚 Installation

To create a new RVST-Stack project, run:

npx create-rvst my-app

or using npm:

npm create rvst my-app

Then navigate to your project and start the development server:

cd my-app
npm run dev

Open your browser and go to http://localhost:5173.

📁 Project Structure

my-app/
├── src/
│   ├── App.jsx
│   ├── components/
│   ├── styles/
│   │   └── main.css
│   └── index.css
├── public/
├── package.json
├── vite.config.js
├── README.md
└── .eslintrc.json

🛠️ Tech Stack

Technology Description
React JavaScript library for UI development
Vite Fast build tool and dev server
Shadcn UI Pre-styled accessible UI components
Tailwind CSS Utility-first CSS framework
ESLint Code linting and formatting

🔌 Vite Plugins Used

Plugin Description
@vitejs/plugin-react Uses Babel for Fast Refresh
@vitejs/plugin-react-swc Uses SWC for Fast Refresh

🤝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to fork this repo and submit a PR. 🚀

📝 License

This project is licensed under the MIT License.
See LICENSE for more details.