create-vault/README.md

A CLI tool to instantly set up a Full Stack (MERN) or Backend project with a structured folder system and pre-installed dependencies.

# 🚀 **Vault - Full Stack & Backend Starter CLI**

🔹 **Kickstart your development journey with Vault!** This CLI tool lets you instantly set up a fully functional backend or full-stack application with just one command. No more manual configurations – just code! 🎯

<div style="text-align: center; margin-top: 20px;">
    <p style="font-size: 1.1rem; margin-bottom: 8px;">Additionally, for the Full Stack option, you have:</p>
    <div style="display: flex; gap: 20px; align-items: center; justify-content: center; flex-wrap: wrap;">
     <img src="https://skillicons.dev/icons?i=react" alt="React" width="64" />
      <img src="https://skillicons.dev/icons?i=vue" alt="Vue" width="64" />
      <img src="https://skillicons.dev/icons?i=angular" alt="Angular" width="64" />
      <img src="https://skillicons.dev/icons?i=tailwindcss" alt="TailwindCSS" width="64" />
       <img src="https://skillicons.dev/icons?i=javascript" alt="JavaScript" width="64" />
       <img src="https://skillicons.dev/icons?i=mongodb" alt="MongoDB" width="64" />
       <img src="https://skillicons.dev/icons?i=express" alt="Express" width="64" />
       <img src="https://skillicons.dev/icons?i=nodejs" alt="Node.js" width="64" />
        </div>
 </div>

### ✨ **Features**

✅ **Choose between Full Stack (MERN) or Backend-only**  
✅ **Pre-configured Express.js Backend**  
✅ **MongoDB Integration with Mongoose**  
✅ **Vite + React + Tanstack Router (Frontend)**  
✅ **Angularjs + TailwindCSS (Frontend)**  
✅ **Vuejs + TailwindCSS (Frontend)**  
✅ **Optional Frontend Frameworks: React, Vue, or Angular**  
✅ **.env File for Easy Configuration**  
✅ **Nodemon for Seamless Development**  
✅ **Pre-structured Folder System**  
✅ **Automatic Dependency Installation**

---


## 🚀 **Installation & Usage**

### 1. **First-Time Setup**

To get started with the VaultBase template, follow these steps:

1. Install the template globally:

   ```sh
   npm install -g create-vault
   ```

2. Initialize the project:
   ```sh
   create-vault
   ```

### 2. **Subsequent Use**

For future projects, you can quickly set up a new VaultBase project by running:

```sh
npx create-vault@latest
```

---


This command will prompt you to select:  
🕐 **Full Stack (MERN)** – Includes both frontend and backend.  
🕐 **Backend Only** – Generates only the server-side setup.

Additionally, for the Full Stack option, you can now choose between:

- ⚡ React
- 🌟 Vue
- 🍇 Angular

---


## 🔧 **Project Structure**

Once generated, your project will look like this:

```
🗁 my-project
 ├── 🗁 app/                # Frontend (Only in Full Stack setup)
 │   ├── 🗍 index.jsx
 │   └── ...
 ├── 🗁 server/             # Backend
 │   ├── 🗁 controllers/
 │   ├── 🗁 models/
 │   ├── 🗁 routes/
 │   ├── 🗁 config/
 │   ├── 🗁 middlewares/
 │   ├── 🗁 utils/
 │   ├── 🗍 .env
 │   ├── 🗍 server.js
 │   ├── 🗍 package.json
 │   └── 🗍 .gitignore
 ├── 🗍 README.md
```

---


## 🔧 **Running the Project**

### 🚀 **Start the Backend**

```sh
cd my-project/server
npm start
```

Before running, update your MongoDB connection in `.env`:

```sh
MONGO_URI=your_mongodb_connection_url
PORT=3000
```

### 🎨 **Start the Frontend (For Full Stack Setup)**

```sh
cd my-project/app
npm run dev
```

---


## 🔧 **Technologies Used**

💻 **Backend**: Node.js, Express.js, Mongoose, Dotenv, Cors, JSON Web Token (optional)  
🎨 **Frontend (Full Stack Setup)**: Vite, React, Vue, Angular, Tanstack Router

---


## 🤝 **Contributing**

🔹 Want to make this even better? Fork the repo, make your changes, and submit a pull request! We welcome all contributions. 💡

---


## 📜 **License**

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

### Attribution

You are free to use, modify, and distribute this project, but please attribute it to the original creator.

Thank you for respecting the authorship and usage terms.

---