create-vault v13.0.1
š 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:
Install the template globally:
npm install -g create-vault
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.
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago