Namaste React 🚀

Welcome to Namaste React! A custom CLI tool to create a React project with a specific structure, tailored to your needs. Simplify your React project setup with just one command! 🎉

Features ✨

• 🚀 Quick Setup: Create React projects with ease and speed.
• 🎨 Customizable Templates: Choose between JavaScript or TypeScript, and CSS or Tailwind CSS.
• 🛠️ Flexible Project Structure: Get started with a predefined structure that suits your development needs.
• 🧑‍💻 User-Friendly Prompts: Simple and intuitive prompts to guide you through the setup process.

Getting Started 🛠️

Installation

To get started with Namaste React, you can run the package using npx:

npx namaste-react <project-name>

How It Works

1. Run the Command: Use npx namaste-react <project-name>.

2. Answer Prompts:

• Choose your preferred JavaScript language: JavaScript or TypeScript.
• Select your CSS framework: Default CSS or Tailwind CSS.

3. Project Creation: Your project will be created with the selected options, ready for development.

Example

npx namaste-react my-new-app

Then follow the prompts to customize your new React project! 🛠️

Project Structure 🗂️

The project will be created with a structure based on your choices. Here's an overview:

my-new-app/
├── src/                     # Main source code
│   ├── components/          # Reusable components
│   ├── styles.css           # CSS/Tailwind styles
│   ├── index.js             # React entry point
│   └── index.html           # Main HTML file
│
├── package.json             # Project configuration
└── README.md                # Project documentation

Templates 📂

Namaste React offers customizable templates based on your choices:

• JavaScript + Default CSS
• JavaScript + Tailwind CSS
• TypeScript + Default CSS
• TypeScript + Tailwind CSS

These templates are stored within the package and copied over during project creation.

Commands 📝

• Start your project: Navigate into your project directory and run:

npm install
npm start

• Initialize Git (optional): The CLI automatically initializes a Git repository for you!

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact 📬

• Prahlad Inala - Your LinkedIn - [e-mail]

• Project Link: GitHub Repository

Made with ❤️ by Prahlad Inala