13.0.1 • Published 4 months ago

create-vault v13.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

šŸš€ 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 (MERN) application with just one command. No more manual configurations – just code! šŸŽÆ


✨ Features

āœ… Choose between Full Stack (MERN) or Backend-only
āœ… Pre-configured Express.js Backend
āœ… MongoDB Integration with Mongoose
āœ… Vite + React + Tanstack Router (Frontend)
āœ… .env File for Easy Configuration
āœ… Nodemon for Seamless Development
āœ… Pre-structured Folder System
āœ… Automatic Dependency Installation


Here's an improved version with a more polished structure and clarity:


šŸš€ Installation & Usage

1. First-Time Setup

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

  1. Install the template globally:

    npm install -g create-vault
  2. Initialize the project:

    create-vault

2. Subsequent Use

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

npx create-vault@latest

This version provides a cleaner breakdown with headings and clear instructions for both first-time and subsequent uses.

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


šŸ— 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

cd my-project/server
npm start

Before running, update your MongoDB connection in .env:

MONGO_URI=your_mongodb_connection_url
PORT=3000

šŸŽØ Start the Frontend (For Full Stack Setup)

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, 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 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.


10.1.1

4 months ago

10.2.1

4 months ago

10.1.2

4 months ago

13.0.0

4 months ago

13.0.1

4 months ago

12.2.1

4 months ago

9.1.1

4 months ago

9.1.0

4 months ago

11.2.1

4 months ago

5.3.0

5 months ago

5.2.0

5 months ago

5.0.2

5 months ago

5.1.0

5 months ago

5.0.1

5 months ago

5.0.0

5 months ago

8.1.0

5 months ago

8.0.0

5 months ago

6.0.1

5 months ago

6.0.0

5 months ago

7.0.2

5 months ago

7.0.1

5 months ago

4.0.0

5 months ago

3.0.0

5 months ago

2.0.0

5 months ago

1.0.4

5 months ago

1.0.3

5 months ago

1.0.2

5 months ago

1.0.1

5 months ago

1.0.0

5 months ago