express-es5-generator v1.0.4

ES5 Express application generator.

Overview

express-es5-generator is a command-line tool that helps you quickly set up a new Express.js application following ES5 standards. This tool generates a project skeleton with all the necessary files and directories, enabling you to start building your Express.js app right away.

Installation

To install express-es5-generator globally, run:

$ npm install -g express-es5-generator

Alternatively, you can use npx to run it directly without global installation:

$ npx express-es5-generator my-app

This will create a new Express.js application in a directory named my-app.

Quick Start

The quickest way to get started with Express.js using ES5 syntax is to utilize the executable express-es5-generator to generate an application as shown below:

$ npx express-es5-generator my-app
$ cd my-app

Install dependencies:

$ npm install

After the project is created, ensure that a .env file is generated in the root folder. Then, copy the content from the env.dev file and paste it into the .env file.

Start your Express.js app at http://localhost:8000/:

$ npm start

Project Structure

The generated project structure is as follows:

my-app/
├── .vscode/
│   └── settings.json
├── config/
│   └── env.config.js
│   └── route.config.js
├── controller/
│   └── auth.controller.js
├── enum/
│   └── api_status.enum.js
├── helper/
│   └── common.helper.js
│   └── exception_wrapper.helper.js
│   └── joi.helper.js
│   └── mail.helper.js
├── routes/
│   └── auth.routes.js
├── schema/
│   └── auth.schema.js
├── test/
├── utils/
├── views/
├── env.dev
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc
├── docker-compose.yml
├── Dockerfile
├── index.js
├── Jenkinsfile
├── package.json
└── README.md

Customization

After generating the project, you can customize it to fit your needs. Modify the routes, views, and middleware as required to develop your Express.js application.

License

MIT