Welcome to Headstarter CLI, the ultimate command-line tool designed to accelerate your project setup! Whether you're a frontend enthusiast or a backend guy, Headstarter CLI simplifies the initial setup process, allowing you to focus on building amazing applications from day one. 🌟
- 🚀 Headstarter CLI
- Project Type Selection: Easily choose between creating a Client or Server project.
- Comprehensive Client Setup:
- Runtimes: Select between
npmorbunfor package management. - React Configurations: Choose between Create React App, Vite (TypeScript or JavaScript).
- UI Libraries: Integrate popular UI libraries like MUI, DaisyUI, or ChakraUI.
- Styling: Optionally add Tailwind CSS for utility-first styling.
- Data Fetching: Choose between Fetch API or Axios.
- State Management: Select state management libraries like MobX, Redux, Zustand, or opt-out.
- Runtimes: Select between
- Robust Server Setup:
- Frameworks: Choose from Express, Fastify, or FastAPI.
- ORMs: Integrate ORMs like Prisma, Sequelize, SQLAlchemy, or Tortoise-ORM based on your server framework.
- TypeScript Support: Optional TypeScript setup for enhanced development experience.
- Automated Dependency Installation: Automatically installs necessary dependencies based on your selections.
- Standardized Project Structure: Creates a well-organized project structure to kickstart your development.
- Interactive CLI: User-friendly prompts guide you through each setup step.
- Customizable: Tailor the generated project to fit your specific needs with a wide range of options.
Starting a new project often involves repetitive tasks like setting up configurations, installing dependencies, and organizing folders. Headstarter CLI eliminates this boilerplate by automating the setup process, allowing you to:
- ⏱️ Save Time: Quickly scaffold projects without manual setup.
- 🔄 Maintain Consistency: Ensure a standardized project structure across different projects.
- 🚀 Enhance Productivity: Focus on writing code and building features instead of setting up environments.
- 🎨 Flexibility: Customize your project setup based on your unique requirements.
Before installing Headstarter CLI, ensure you have the following installed on your system:
- Node.js (version >=14.0.0)
- npm or bun (if you prefer using
bunas your runtime) - Git (optional, for cloning the repository)
npm install -g headstarter-clinpx headstarter-clibun install -g headstarter-clibunx headstarter-cli✅ Installation Complete! You can now use the headstarter command globally.
-
Run the CLI Tool
headstarter-cli
-
Follow the Interactive Prompts
- Select Project Type: Choose Client
- Choose Runtime: Select between npm or bun
- Select React Setup: Choose your preferred React configuration
- Integrate UI Library: Pick a UI library like MUI, DaisyUI, or ChakraUI
- Add Tailwind CSS: Optionally add Tailwind CSS for styling
- Choose Data Fetching Library: Select between Fetch API or Axios
- Select State Management: Choose a state management library or opt-out
- Name Your App: Provide a name for your application
-
Wait for the Setup to Complete The CLI will handle project creation, dependency installation, and configuration automatically.
-
Navigate to Your Project
cd your-app-name -
Start Development
npm start # or if using bun bun run start
-
Run the CLI Tool
headstarter-cli
-
Follow the Interactive Prompts
- Select Project Type: Choose Server
- Choose Server Framework: Select from Express, Fastify, or FastAPI
- Select ORM: Choose an ORM compatible with your server framework or opt-out
- Select Runtime: If applicable, choose between npm or bun
- Name Your App: Provide a name for your application
-
Wait for the Setup to Complete The CLI will set up the server project with the selected options.
-
Navigate to Your Project
cd your-app-name -
Start the Server
npm start # or if using bun bun run start
- Runtimes: npm, bun
- React Setups:
- Create React App
- Vite (TypeScript & JavaScript)
- UI Libraries:
- MUI (Material-UI)
- DaisyUI
- ChakraUI
- Styling: Tailwind CSS (optional)
- Data Fetching: Fetch API, Axios
- State Management: MobX, Redux, Zustand
- Frameworks:
- Express (JavaScript & TypeScript)
- Fastify (JavaScript & TypeScript)
- FastAPI (Python)
- ORMs:
- Prisma
- Sequelize
- SQLAlchemy
- Tortoise-ORM
Contributions are welcome! If you'd like to improve Headstarter CLI, please follow these steps:
-
Fork the Repository
-
Create a New Branch
git checkout -b feature/YourFeature
-
Make Your Changes
-
Commit Your Changes
git commit -m "Add Your Feature" -
Push to the Branch
git push origin feature/YourFeature
-
Open a Pull Request
- Describe your changes
- Submit the pull request for review
Personal Use and Contribution License
Copyright (c) [2024] [Ishaan Pandey]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use the Software for personal, non-commercial purposes only, subject to the following conditions:
-
Commercial use, including but not limited to using the Software to earn revenue or integrate into commercial products, is strictly prohibited.
-
Contributions to the Software are allowed and encouraged via pull requests, provided they comply with the non-commercial nature of this license.
-
Distribution of modified versions of the Software must retain this license and all copyright notices.
-
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.
For any inquiries or feedback, please contact:
- Your Name
- Email: [email protected]
- GitHub: github.com/git-ishaan