express-auto-helper

Express Auto Helper

Express Auto Helper is a CLI tool designed to help you quickly generate Express.js controllers and routes. This tool will automatically create a new controller or route file and link it to the main index.js files in your project, making it easier to scale your Express application.

Features

• Controller Generation: Easily create controllers with pre-defined methods (index, show, create, update, delete).
• Route Generation: Create routes that are linked to their respective controllers.
• Automatic Linking: The tool automatically updates the index.js files within the controllers and routes folders, so new controllers and routes are immediately usable.

Installation

Install the package globally,

npm i -g express-auto-helper

Usage

Once the package is installed, you can use the following commands to generate controllers and routes.

1. Creating a new Project

To create a new project, run:

express-auto-helper create-app <new-app>

Example

express-auto-helper create-app new-app

2. Creating a Controller

To create a new controller, run:

express-auto-helper create-controller <controllerName>

This command will create a new file in the controllers folder with the specified name, and it will automatically add an export to the index.js in the controllers folder.

Example

express-auto-helper create-controller userController

This will create a file called userController.js in the controllers folder with the following default methods:

• index
• show
• create
• update
• delete

3. Creating a Route

To create a new route, run:

express-auto-helper create-route <routeName>

This command will create a new file in the routes folder with the specified name, and it will automatically import and use the corresponding controller. It also updates the index.js in the routes folder for easy access.

Example

express-auto-helper create-route user

This will create a file called user.js in the routes folder with pre-configured routes for:

• GET /
• GET /:id
• POST /
• PUT /:id
• DELETE /:id

4. Linking Routes and Controllers in the Main index.js

The tool automatically updates the main index.js file to link all routes. To set up the main file manually, you can include the following code in index.js:

const express = require('express');
const app = express();
const routes = require('./routes');

app.use(express.json());

// Link all routes
Object.keys(routes).forEach((routeName) => {
  app.use('/' + routeName, routes[routeName]);
});

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

File Structure

The CLI tool will create a folder structure like this:

my-express-app/
├── controllers/
│   ├── index.js
│   └── userController.js
├── routes/
│   ├── index.js
│   └── user.js
└── index.js

License

No lisence **

Contributing

Contributions are welcome! If you have any feature requests or find any bugs, feel free to submit an issue or create a pull request.

---

Enjoy building with Express Auto Helper!