1.0.5 • Published 12 months ago

auto-init-cloudboy v1.0.5

Weekly downloads
-
License
ISC
Repository
github
Last release
12 months ago

auto-init-cloudboy

auto-init-cloudboy is a CLI tool that simplifies the setup process for modern web projects by automating the creation of React applications using Vite, installing Tailwind CSS, configuring Firebase, and setting up GitHub Actions for CI/CD.


Features

  • React + Vite: Quickly initialize a React project with Vite.
  • Tailwind CSS: Automates the setup of Tailwind CSS for styling.
  • Firebase Integration: Optionally configure Firebase for backend services.
  • GitHub Actions: Sets up CI/CD pipelines automatically.
  • Customizable Project Structure: Choose frontend and backend directories based on your preference.

Installation

Global Installation

Install the tool globally:

npm install -g auto-init-cloudboy

Then, run it using:

auto-init-cloudboy

Using npx (No Global Installation Required)

You can also run it directly without installation:

npx auto-init-cloudboy

Usage

When you run auto-init-cloudboy, it will guide you through a series of questions:

  1. Frontend Setup: Do you want to create a React project?
  2. Tailwind CSS: Add Tailwind CSS for styling?
  3. Firebase: Set up Firebase?
  4. GitHub Actions: Configure CI/CD for GitHub?

Example Command

auto-init-cloudboy

Project Directory Structure

/my-new-project  
  ├── /frontend        # React app  
  │   ├── /src  
  │   └── tailwind.config.js  
  └── /backend         # Optional backend setup (Firebase or custom)  

Alternative Installation via @jaiminbariya/auto-init

If you'd prefer a scoped package:

npm install -g @jaiminbariya/auto-init

Then, use the command:

auto-init

Development

Contributing

Contributions are welcome! Here's how to set up your local development environment:

  1. Clone the repository:
    git clone https://github.com/jaiminbariya/auto-init-cloudboy.git
  2. Navigate to the project directory:
    cd auto-init-cloudboy  
  3. Install dependencies:
    npm install  
  4. Link the package for local testing:
    npm link  
  5. Run the CLI locally:
    auto-init-cloudboy  

License

This project is licensed under the MIT License.


Acknowledgments

  • Inspired by tools like create-react-app, Vite, and Tailwind CSS.
  • Thanks to the open-source community for supporting Firebase and GitHub Actions integration.