ExpressJet: Express & MongoDB Boilerplate Generator
Crafting smooth, modern, and smart digital experiences.
Are you tired of setting up the same Express.js and MongoDB boilerplate for every new backend project? ExpressJet is your flight ticket to instantly generate a robust, well-structured, and customizable backend foundation directly within VS Code! Get productive in seconds, not minutes, and focus on building the interactive experiences you love.
✨ Features & Benefits
- ⚡️ Instant Backend Setup: Generate a complete Express.js and MongoDB project structure with a single command.
- ⚙️ Highly Customizable:
- Package Manager: Choose between
npm or yarn .
- Module System: Select
CommonJS (using require /module.exports ) or ES Modules (using import /export ).
- Authentication Boilerplate (NEW!): Opt to include a ready-to-use JWT-based email/password authentication system, complete with user registration, login, token generation, and protected routes.
- 📁 Opinionated Structure: Get a clean, scalable folder structure (
server.js , src/config , src/controllers , src/models , src/routes , src/middlewares , src/utils ) out-of-the-box.
- 💡 Ready-to-use Examples: Includes a basic "User" CRUD (Create, Read) example, and if chosen, full authentication routes and middlewares to kickstart your development.
- 📦 Automated Dependency Installation: ExpressJet automatically installs
express , mongoose , dotenv , nodemon , and (conditionally) bcryptjs and jsonwebtoken for you.
- 📝 Comprehensive
README.md : The generated project comes with its own detailed README.md including installation, run instructions, and API endpoint details.
- 🚀 Boost Your Productivity: Stop wasting time on repetitive setup tasks and dive straight into crafting your application logic. Perfect for young, growing, and learning developers eager to build interactive experiences.
🚀 Installation
Install ExpressJet directly from the Visual Studio Code Marketplace:
- Open VS Code.
- Go to the Extensions view (
Ctrl+Shift+X or Cmd+Shift+X ).
- Search for "ExpressJet" or "NishantUnavane".
- Click the "Install" button.
Alternatively, install it via the VS Code Marketplace website:
Install ExpressJet from VS Code Marketplace (This link will work once published!)
✈️ How to Use ExpressJet
Using ExpressJet is designed to be incredibly simple and guided:
- Prepare Your Workspace: Open an empty folder in VS Code where you want your new Express.js backend project to be created.
- Launch the Command:
- Open the VS Code Command Palette by pressing
Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
- Type
ExpressJet and select the command: ExpressJet: Generate Express & MongoDB Backend .
- Follow the Interactive Prompts:
- Project Name: Enter a descriptive name for your new backend project (e.g.,
my-cool-api ). This will be used for your package.json and database URI.
- Package Manager: Choose your preferred package manager between
npm or yarn .
- Module System: Decide if you want
CommonJS (require /module.exports ) or modern ES Modules (import /export ) for your project.
- Include Authentication? (NEW!): Select
Yes to add a robust email/password authentication system using JWTs, or No for a simpler boilerplate.
- Instant Generation & Installation:
- ExpressJet will swiftly generate the complete folder structure and boilerplate files based on your choices.
- An integrated VS Code terminal will automatically open and run
${packageManager} install to fetch all necessary dependencies.
- Start Developing!
- Once dependencies are installed, you're ready to run your server. Check the newly generated
README.md inside your project for details on how to start the server (npm run dev or yarn dev ).
- For projects with authentication, the generated
README.md will also provide details on the /api/auth/register and /api/auth/login endpoints.
📂 Generated Folder Structure
Your new project will have a clean, logical structure ready for expansion:
Alright, Nishant, let's refine your ExpressJet extension's README.md to be even more engaging, highlight the new authentication feature, and provide clear, simple instructions, while removing the screenshots as requested.
Here's the improved README.md content:
Markdown
ExpressJet: Express & MongoDB Boilerplate Generator
Crafting smooth, modern, and smart digital experiences.
Are you tired of setting up the same Express.js and MongoDB boilerplate for every new backend project? ExpressJet is your flight ticket to instantly generate a robust, well-structured, and customizable backend foundation directly within VS Code! Get productive in seconds, not minutes, and focus on building the interactive experiences you love.
✨ Features & Benefits
- ⚡️ Instant Backend Setup: Generate a complete Express.js and MongoDB project structure with a single command.
- ⚙️ Highly Customizable:
- Package Manager: Choose between
npm or yarn .
- Module System: Select
CommonJS (using require /module.exports ) or ES Modules (using import /export ).
- Authentication Boilerplate (NEW!): Opt to include a ready-to-use JWT-based email/password authentication system, complete with user registration, login, token generation, and protected routes.
- 📁 Opinionated Structure: Get a clean, scalable folder structure (
server.js , src/config , src/controllers , src/models , src/routes , src/middlewares , src/utils ) out-of-the-box.
- 💡 Ready-to-use Examples: Includes a basic "User" CRUD (Create, Read) example, and if chosen, full authentication routes and middlewares to kickstart your development.
- 📦 Automated Dependency Installation: ExpressJet automatically installs
express , mongoose , dotenv , nodemon , and (conditionally) bcryptjs and jsonwebtoken for you.
- 📝 Comprehensive
README.md : The generated project comes with its own detailed README.md including installation, run instructions, and API endpoint details.
- 🚀 Boost Your Productivity: Stop wasting time on repetitive setup tasks and dive straight into crafting your application logic. Perfect for young, growing, and learning developers eager to build interactive experiences.
🚀 Installation
Install ExpressJet directly from the Visual Studio Code Marketplace:
- Open VS Code.
- Go to the Extensions view (
Ctrl+Shift+X or Cmd+Shift+X ).
- Search for "ExpressJet" or "NishantUnavane".
- Click the "Install" button.
Alternatively, install it via the VS Code Marketplace website:
Install ExpressJet from VS Code Marketplace (This link will work once published!)
✈️ How to Use ExpressJet
Using ExpressJet is designed to be incredibly simple and guided:
- Prepare Your Workspace: Open an empty folder in VS Code where you want your new Express.js backend project to be created.
- Launch the Command:
- Open the VS Code Command Palette by pressing
Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
- Type
ExpressJet and select the command: ExpressJet: Generate Express & MongoDB Backend .
- Follow the Interactive Prompts:
- Project Name: Enter a descriptive name for your new backend project (e.g.,
my-cool-api ). This will be used for your package.json and database URI.
- Package Manager: Choose your preferred package manager between
npm or yarn .
- Module System: Decide if you want
CommonJS (require /module.exports ) or modern ES Modules (import /export ) for your project.
- Include Authentication? (NEW!): Select
Yes to add a robust email/password authentication system using JWTs, or No for a simpler boilerplate.
- Instant Generation & Installation:
- ExpressJet will swiftly generate the complete folder structure and boilerplate files based on your choices.
- An integrated VS Code terminal will automatically open and run
${packageManager} install to fetch all necessary dependencies.
- Start Developing!
- Once dependencies are installed, you're ready to run your server. Check the newly generated
README.md inside your project for details on how to start the server (npm run dev or yarn dev ).
- For projects with authentication, the generated
README.md will also provide details on the /api/auth/register and /api/auth/login endpoints.
📂 Generated Folder Structure
Your new project will have a clean, logical structure ready for expansion:
- your-project-name/
- ├── .env
- ├── .gitignore
- ├── package.json
- ├── README.md
- ├── server.js # Main server entry * point (or server.mjs)
- └── src/
- ├── app.js # Express app * configuration (or app.mjs)
- ├── config/
- │ └── db.js # MongoDB connection * (or db.mjs)
- ├── controllers/
- │ ├── auth.controller.js # User * authentication logic (if selected)
- │ └── example.controller.js # Example CRUD * logic
- ├── models/
- │ └── User.model.js # User schema (updated * for auth if selected)
- ├── routes/
- │ ├── auth.route.js # Auth API routes (if * selected)
- │ └── example.route.js # Example API routes
- ├── middlewares/
- │ └── auth.middleware.js # JWT protection * middleware (if selected)
- └── utils/
| |