DEVI CLI

Description

DEVI CLI is a command-line interface tool designed to streamline the setup process for React projects. It automatically configures projects with Vite, Tailwind CSS, and ShadCN UI, saving developers time on initial configuration and allowing them to focus on building their applications.

Features

• Quick Project Setup: Bootstrap a new React project with a single command
• Vite Integration: Uses Vite for fast development server and optimized builds
• Tailwind CSS Configuration: Pre-configured with Tailwind CSS for utility-first styling
• ShadCN UI Components: Includes ShadCN UI for beautiful, accessible UI components
• Customizable Templates: Various project templates to choose from
• Developer-Friendly: Minimizes boilerplate code and configuration time

Installation

Install DEVI CLI globally using npm:

npm install -g devi-cli

Or using yarn:

yarn global add devi-cli

Usage

Create a new project

devi create my-app

This will create a new React project with Vite, Tailwind CSS, and ShadCN UI in a directory called my-app.

Project Structure

After creation, your project structure will look like this:

my-app/
├── node_modules/
├── public/
├── src/
│   ├── components/
│   ├── lib/
│   ├── App.jsx
│   ├── index.css
│   └── main.jsx
├── .gitignore
├── index.html
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── vite.config.js

Available Commands

• devi create [project-name] - Create a new project
• devi --help - Show help information
• devi --version - Show CLI version

Contributing

Contributions are welcome! To contribute to DEVI CLI:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2023 DEVI CLI

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.