https://github.com/parthamk/clijs
Full-Stack Project setup with just one command
https://github.com/parthamk/clijs
Last synced: 6 months ago
JSON representation
Full-Stack Project setup with just one command
- Host: GitHub
- URL: https://github.com/parthamk/clijs
- Owner: parthamk
- Created: 2025-08-18T19:57:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-18T20:01:42.000Z (7 months ago)
- Last Synced: 2025-08-18T22:07:36.087Z (7 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Full-Stack Project setup with just one command (cli.js)
A **Node.js CLI tool** 🛠️ that auto-generates a **full-stack project boilerplate** with your choice of **ReactJS or Vite for Frontend** and **Express.js (with SQL or MongoDB) for Backend**.
This saves you hours of repetitive manual setup and lets you start **coding right away** 🚀
---
## 🌟 Features
✅ **Interactive CLI** powered by **Inquirer.js**
✅ Choose **React (CRA)** or **Vite** as frontend framework
✅ Support for **JavaScript** or **TypeScript**
✅ Backend setup with **Express.js + Sequelize (SQL)** or **Express.js + Mongoose (MongoDB)**
✅ Auto-installs **CORS, dotenv, react-router-dom** by default
✅ Choose styling: **CSS, Bootstrap, or Tailwind CSS** 🎨
✅ Pre-configures **frontend-backend proxy** (CRA or Vite)
✅ Adds a default **health-check route (`/status`)** to test full-stack connectivity
✅ Optional installation of **ESLint \& Prettier** for clean coding
✅ Works across **Windows, macOS, and Linux** 🖥️
---
## 🏗️ Technologies Used
### 🔹 Core
- [Node.js](https://nodejs.org/) (CLI tool \& package manager)
- [Inquirer.js](https://www.npmjs.com/package/inquirer) – for CLI prompts
- [Chalk](https://www.npmjs.com/package/chalk) – for colorful CLI output
- [fs-extra / fs](https://www.npmjs.com/package/fs-extra) – for file system handling
### 🔹 Frontend Options
- **React (CRA) or Vite**
- **JavaScript / TypeScript**
- Styling frameworks:
- CSS
- Bootstrap
- Tailwind CSS
### 🔹 Backend Options
- **Express.js** (default backend framework)
- Database Choices:
- **SQL** → Sequelize + SQLite (default, can expand to PostgreSQL, MySQL, etc.)
- **MongoDB** → Express + Mongoose
### 🔹 Optional Packages
- `react-router-dom` – routing in React ⚡
- `cors` – enable CORS in Express
- `dotenv` – environment variable management
- `eslint` – linting 🧹
- `prettier` – code formatting
---
## 🎯 Motive of the Project
The goal of this project is to **streamline and automate full-stack setup**.
Instead of wasting time configuring projects manually, this CLI lets you:
1. **Choose your stack interactively** 🖱️
2. **Generate ready-to-run frontend + backend apps** ⚡
3. **Start building features instantly** 🚀
This project is built for **students, developers, and teams** who create multiple projects and want a **consistent, fast, and reliable setup**.
---
## 🔮 Future Implementations
✨ Add **Next.js** as a frontend option
✨ Support for **PostgreSQL, MySQL, and MongoDB Atlas by default**
✨ Auto-generate **Dockerfile \& docker-compose.yml** for containerization
✨ Add **Redux / Zustand / TanStack Query** as optional frontend state managers
✨ Auto-create **unit tests** with Jest / Mocha
✨ Add **GitHub Actions CI/CD pipeline** support
---
## ⚡ Installation \& Usage
### 🔹 1. System Requirements
- [Node.js](https://nodejs.org/) **v14+**
- [npm](https://www.npmjs.com/) (bundled with Node.js)
- Git installed (recommended for Vite and CRA)
- Any OS: **Windows / macOS / Linux**
---
### 🔹 2. Clone \& Run
```bash
# Clone this repo
git clone https://github.com/parthamk/CLIJS.git
cd CLIJS
# Make file executable (Linux/Mac)
chmod +x cli.js
# Run the script
./cli.js
```
### 🔹 3. Using with Node
```bash
node cli.js
```
---
### 🔹 4. Workflow in VS Code
1. Open project in VS Code:
```bash
code .
```
2. Navigate to **server**:
```bash
cd server
node index.js # Runs backend on http://localhost:5000
```
3. Navigate to **client**:
```bash
cd ../client
npm start # Starts React app (frontend)
```
4. Visit:
- Frontend → `http://localhost:3000` (CRA) or `http://localhost:5173` (Vite)
- Backend → `http://localhost:5000/status`
---
## 📂 Project Structure
```
project-name/
│── client/ # React/Vite frontend
│ └── src/ # React source files
│── server/ # Express backend
│ └── index.js # Entry point (API + DB setup)
│── cli.js # The CLI script
```
---
## 🎉 Example Welcome Screen (Frontend)
When you run your project, the frontend will fetch backend status and show:
```
✔ Frontend is running successfully
✔ Server is running successfully
All systems check complete. Happy hacking! 🚀
```
---
## 👨💻 Contribution
Contributions are always welcome! 🙌
- Fork repo
- Create feature branch
- Submit PR
---
## 📜 License
[MIT License](LICENSE) – Free to use \& modify.
---
🔥 With this CLI tool, you save **time + effort** and kickstart your dev projects with **best practices pre-configured**.
> 💡 Recommended: Keep this tool globally installed using:
> ``bash > npm install -g . > cli.js > ``
---