Vite ShadCN Setup

Automate Vite Project Setup with React, TypeScript, Tailwind CSS, ShadCN UI, and More

vite-shadcn-setup is a CLI tool designed to streamline the setup of a Vite project with essential configurations for modern frontend development. It integrates React, TypeScript, Tailwind CSS, ShadCN UI, and other popular tools to get your project up and running in no time.

Features

• Quick Setup: Automates the creation of a Vite-based project with React, TypeScript, Tailwind CSS, and ShadCN UI.
• Customizable: Easily extendable to include additional configurations or dependencies.
• One-Step Installation: Simple CLI command to initialize your project.

Installation

To install vite-shadcn-setup, run the following command:

npm install -g vite-shadcn-setup

Alternatively, you can use npx to run it without installation:

npx vite-shadcn-setup

Usage

Once installed, you can use the CLI tool to automate the setup of your Vite project. Simply run:

vite-setup

You will be prompted to enter the name of your project, and the tool will handle the rest.

Example

Here's a step-by-step example of how the tool works:

1. Run the following command to start the setup process:

   npx vite-shadcn-setup

2. Enter the name of your project when prompted.

3. The tool will create a Vite project with all the necessary configurations, including:

   • React
   • TypeScript
   • Tailwind CSS
   • ShadCN UI

Future Enhancements

Currently, this tool supports Vite and ShadCN as libraries and frameworks, and bun and npm as package managers. In future releases, we plan to add support for:

• Additional frameworks such as Next.js and Aceternity UI
• More package managers like Yarn and pnpm
• Enhanced configuration options for Tailwind CSS
• Integration with popular state management libraries
• Improved testing setups with Jest and React Testing Library

Stay tuned for updates!

Contributing

We welcome contributions to this project. If you'd like to contribute, please fork the repository, create a new branch, and submit a pull request. Contributions, bug reports, and feature requests are appreciated!

License

This project is licensed under the MIT License.

Author

• Zaid Rakhange - GitHub Profile

Acknowledgments

• Vite - A fast, modern build tool.
• ShadCN UI - A utility-first UI library.
• Tailwind CSS - A utility-first CSS framework.