devsprint-cli
v1.1.1
Published
**DevSprintCLI** is an open-source Command Line Interface (CLI) tool designed to simplify and automate the setup of development environments for modern web applications. Whether you're building a **frontend**, **backend**, or **full-stack** project, DevSp
Readme
DevSprintCLI
DevSprintCLI is an open-source Command Line Interface (CLI) tool designed to simplify and automate the setup of development environments for modern web applications. Whether you're building a frontend, backend, or full-stack project, DevSprintCLI provides a seamless and efficient way to bootstrap your projects with pre-configured templates, folder structures, and essential dependencies.
Features
- Quick Setup: Initialize backend, frontend, or full-stack projects with a single command.
- Customizable Templates: Pre-configured setups for React (frontend) and Express.js (backend).
- Git Integration: Automatically initialize a Git repository and optionally add a remote origin.
- AI-Powered Assistance:
- Analyze your project structure and suggest improvements.
- Generate files based on your requirements.
- Perform code reviews and error analysis.
- Pre-configured Tools:
- Frontend: Vite, React, Redux Toolkit, TailwindCSS, React Router.
- Backend: Express, Mongoose, Winston, Rate Limiter, and more.
- Open Source: Fully customizable and open for contributions.
Usage
No installation required. Use npx to run the CLI directly:
npx devsprint-cliYou will be prompted to select:
- Project Type: Backend, Frontend, or Full Stack.
- Project Name: Name of your project directory.
- Git Initialization: Optionally initialize a Git repository and add a remote origin.
AI-Powered Features
These commands are used directly with npx:
🔍 Analyze Project Structure
npx devsprint-cli --suggestAnalyze your project structure and get tailored suggestions for improvements.
🧪 Code Review
npx devsprint-cli --ai-reviewPerform an AI-powered code review for a specific file.
📁 Generate Files
npx devsprint-cli --ai-genfileGenerate a new file based on your requirements.
❌ Diagnose Errors
npx devsprint-cli --ai-errorDiagnose and fix errors in your code.
💬 AI Chat Mode
npx devsprint-cli --ai-chatEnter an interactive chat mode with the AI assistant.
📂 Project Structure
Frontend
src/
├── components/
│ ├── Button.jsx
│ └── Navbar.jsx
├── pages/
│ ├── Home.jsx
│ ├── About.jsx
│ └── NotFound.jsx
├── store/
│ └── store.js
├── App.jsx
├── main.jsx
└── index.css
vite.config.jsBackend
src/
├── config/
│ ├── db.js
│ └── logger.js
├── controllers/
│ └── userController.js
├── middleware/
│ ├── errorMiddleware.js
│ └── rateLimiter.js
├── models/
│ └── userModel.js
├── routes/
│ └── userRoutes.js
├── app.js
└── server.js
.env
Dockerfile📦 Dependencies
Frontend
- Core: React, Redux Toolkit, React Router
- Styling: TailwindCSS
- Utilities: Axios, React Toastify, React Icons
Backend
- Core: Express, Mongoose
- Utilities: Dotenv, Cors, Morgan, Cookie-Parser
- Middleware: Express Rate Limiter, Winston for logging
- Dev Tools: Nodemon, ESLint, Prettier
📖 Command Summary
| Command | Description |
| -------------------------------- | ------------------------------------------------------- |
| npx devsprint-cli | Start the interactive CLI to set up a project. |
| npx devsprint-cli --suggest | Analyze the project structure and suggest improvements. |
| npx devsprint-cli --ai-review | Perform an AI-powered code review. |
| npx devsprint-cli --ai-genfile | Generate a file based on your requirements. |
| npx devsprint-cli --ai-error | Diagnose and fix errors in your code. |
| npx devsprint-cli --ai-chat | Start an AI-powered interactive chat. |
🌟 Full Stack Project Example
npx devsprint-cli- Select Full Stack as the project type.
- Enter the project name (e.g.,
my-fullstack-app). - Choose whether to initialize a Git repository.
- The tool will scaffold both frontend and backend directories.
Run Your Project
Start the backend:
cd backend npm run devStart the frontend:
cd frontend npm run dev
📜 License
This project is licensed under the MIT License. See the LICENSE file for details.
🤝 Contributing
We welcome contributions from the community! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -m 'Add your feature'). - Push to the branch (
git push origin feature/your-feature). - Open a pull request.
🛡️ Security
If you discover any security vulnerabilities, please report them by opening an issue or contacting the maintainers directly.
📧 Contact
- Author: Nisharg Soni
- GitHub: https://github.com/Nisharg-04
🏗️ Future Roadmap
- ✅ Add support for TypeScript.
- ✅ Expand AI-powered capabilities.
- ✅ Support more frameworks like Angular and Vue.
- ✅ CI/CD pipeline integration.
