create-react-tailwind v1.0.6
create-react-tailwind
š Description
create-react-tailwind is a powerful CLI tool designed to streamline the setup of new React or Vite projects with Tailwind CSS integration and a predefined folder structure. Simplify your project initialization and boost your productivity.
š Features
- Project Creation: Easily create new React or Vite projects.
- Tailwind CSS Setup: Automatically configure Tailwind CSS for your project.
- Predefined Folder Structure: Generate a consistent and organized folder structure to kickstart your development.
š¦ Installation
To install the package globally, use the following command:
npm install -g create-react-tailwind
š Usage
After installing the package globally, create a new project by running:
create-react-tailwind <appname>
Alternatively, you can use npx
to run the CLI tool without global installation:
npx create-react-tailwind <appname>
You will be prompted to choose between creating a React or Vite project.
Example
To create a new project named my-app
:
create-react-tailwind my-app
or
npx create-react-tailwind my-app
š Folder Structure
The following folder structure will be created within the src
directory:
š src
āāā š app
ā āāā š contexts
ā āāā š hook
ā āāā š services
āāā š assets
ā āāā š icon
ā āāā š images
āāā š components
ā āāā š core
ā āāā š router
ā āāā š sections
āāā š constants
āāā š lib
āāā š pages
āāā š util
š public
š¬ Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
š License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
š¤ Author
- Het Shah
š Issues
Feel free to report issues or request new features.
š¬ Contact
- GitHub: het-shah-25
š Keywords
CLI tool, React project setup, Vite project setup, Tailwind CSS integration, predefined folder structure, project scaffolding, React, Vite, Tailwind CSS, frontend development, web development tools