vite-shadcn-starter
v0.0.1
Published
A Vite starter template with shadcn installed
Readme
vite-shadcn-starter
A simple CLI tool to quickly create a new React project with Vite, Tailwind CSS, and ShadCN UI components pre-installed. This package sets up the basic configuration for you, so you can start developing without any setup hassle.
Features
- Installs Vite as the build tool.
- Sets up Tailwind CSS for styling.
- Pre-configures ShadCN UI components for a complete UI framework.
- Creates a fully functional React project.
- Automatically installs necessary dependencies.
Installation
To install this package globally, run the following command:
npm install -g vite-shadcn-starterUsage
To create a new React project with Vite, Tailwind CSS, and ShadCN pre-configured, run the following command from your desired directory:
npx vite-shadcn-starter <your-project-directory>This will:
- Copy the template files into the specified directory (or current directory by default).
- Install all the necessary dependencies with
npm install. - Once completed, your React project with Vite, Tailwind CSS, and ShadCN will be ready to use!
Example
npx vite-shadcn-starter my-new-projectTo run the project
cd my-new-projectnpm run devThis will create a new React project called my-new-project with Vite, Tailwind CSS, and ShadCN pre-configured.
Acknowledgments
- Vite for the fast and modern development build tool.
- Tailwind CSS for utility-first CSS styling.
- ShadCN for the UI components used.
