Express API Initializer is a tool designed to streamline the process of generating Express.js applications.
Ensure you have node.js) installed, then install express-api-initializer globally using npm:
npm install -g express-api-initializer
To create a new project, run:
express-initializer new <app-name>
Your app structure will be initialized as follows:
📦app ┣ 📂config ┣ 📂src ┃ ┣ 📂controllers ┃ ┃ ┗ 📜users.controller.js ┃ ┣ 📂middlewares ┃ ┃ ┣ 📜error.middleware.js ┃ ┃ ┗ 📜users.middleware.js ┃ ┣ 📂models ┃ ┃ ┗ 📜users.model.js ┃ ┣ 📂routes ┃ ┃ ┗ 📜users.route.js ┃ ┗ 📜app.js ┣ 📜index.js ┗ 📜package.json
To start the app, navigate to the project directory and run:
cd <app-name>
npm install express express-async-handler
node index.js
Generate resources using plural nouns:
express-initializer g resource <resource-name>
Generate controllers using:
express-initializer g controller <controller-name>
Generate models using:
express-initializer g model <model-name>
Generate routes using:
express-initializer g route <route-name>
Generate middleware using:
express-initializer g middleware <middleware-name>
Generate configs using:
express-initializer g config <config-name>
Feel free to use these commands to efficiently scaffold and organize your Express.js applications.