Express Rest Boilerplate

A Minimal Starter Boilerplate for NodeJS REST API with ExpressJS & MongoDB.

Tech Stack

Language: JavaScript
Server: NodeJS, ExpressJS
Database: MongoDB

Project Structure

1express-rest-boilerplate
2 ┣ src
3 ┃ ┣ config
4 ┃ ┃ ┗ conn.js
5 ┃ ┣ controllers
6 ┃ ┃ ┣ auth
7 ┃ ┃ ┃ ┣ auth.controller.js
8 ┃ ┃ ┃ ┗ auth.validator.js
9 ┃ ┃ ┣ user
10 ┃ ┃ ┃ ┣ user.controller.js
11 ┃ ┃ ┃ ┗ user.validator.js
12 ┃ ┃ ┗ file.controller.js
13 ┃ ┣ models
14 ┃ ┃ ┗ User.model.js
15 ┃ ┣ routes
16 ┃ ┃ ┣ auth.routes.js
17 ┃ ┃ ┣ file.routes.js
18 ┃ ┃ ┗ user.routes.js
19 ┃ ┣ utils
20 ┃ ┃ ┣ config.js
21 ┃ ┃ ┣ protected.js
22 ┃ ┃ ┣ response.js
23 ┃ ┃ ┗ securePassword.js
24 ┃ ┗ view
25 ┃ ┃ ┗ serverRunning.html
26 ┣ uploads
27 ┃ ┗ LOCAL_FILE_UPLOADS
28 ┣ .gitignore
29 ┣ LICENCE
30 ┣ package.json
31 ┣ README.md
32 ┣ server.js
33 ┗ yarn.lock

How to use?

You can use this template as starter package of express/mongo

Install as starter pack

To use as starter pack

1npx express-mongo-boilerplate <folder_name>

Connect with database

To connect with MongoDB please go to the src folder then open config folder.

1  cd src
2  cd config

and open database file and add your database connection string like below.

1module.exports = {
2  database:
3    'mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]',
4}

How to run?

For development environment:

1  npm run dev

If you are using yarn

1  yarn dev

For production environment:

1  npm start

If you are using yarn

1  yarn start

PORT

In the development server by default, it will open at port 5000, and in the production server, it will open in the server's default port.

Authors

• @ahmmedabir9

Contributors