Express Basic Starter

Express Basic Starter is a command-line interface (CLI) tool that simplifies the process of setting up a basic Express.js project with a structured folder layout, essential packages, and Swagger documentation, fully compatible with ES modules.

Features

• Quick Setup: Initialize a new Express project with one command.
• MVC Folder Structure: Organized folders for controllers, models, and routes.
• Basic Packages: Includes essential npm packages pre-configured.
• Swagger Documentation: Integrated Swagger documentation for APIs.
• Customizable: Easily extend or modify the generated project structure.
• ES Module Support: Fully compatible with ES module syntax.

Installation

Install the CLI tool globally to use it from anywhere:

npm install -g express-basic-starter

express-basic-starter <project-name>

Alternatively, you can use npx to run the tool without installing it globally:

npx express-basic-starter <project-name>

Usage with ES Modules

To create a project using ES module syntax, use the --es flag:

npx express-basic-starter <project-name> --es

Project Folder Structure

my-express-app
├── app.js
├── package.json
├── package-lock.json
├── .gitignore
├── controllers
│ └── sampleController.js
├── docs
│ └── swagger
│       └── testDocs.js
├── models
│ └── sampleModel.js
├── routes
│ └── sampleRoute.js
├── utils
│ └── error.js
│ └── jwt.js
│ └── response.js
└── uploads