douglaslira / express-gateway-boilerplate

Express Gateway Boilerplate - v1.0

Express Gateway Boilerplate I created this repository to register an example of a gateway using Express + Mongo. I leave it open for those who want to contribute to future improvements

Table of contents

• Express Gateway Boilerplate - v1.0
  • Table of contents
  • General info
  • Screenshots
  • Technologies
  • Setup
  • Commands
  • Features
  • Status
  • Contact

General info

Express Gateway Boilerplate

Screenshots

Technologies

• Node
• MongoDB

Setup

⚠️ Before install node packages:

• MongoDB must be installed, create a "app_base" DataBase and a "user" collection;

• Check and configure the mongo access endpoint, editing the constants file, inside the config directory;

• This project use node v14.4.0;

1 - Clone this repository

~$ git clone <GIT_URL>

2 - Execute commands:

~$ cd <project_name>
~$ npm install
~$ npm run serve

3 - Test access URL:

~$ curl http://localhost:8080

Commands

• npm run clean - Clean folder dist

~$ npm run clean

• npm run copy-deps - Copy dependencies to dist folder

~$ npm run copy-deps

• npm run start - Start server

~$ npm run start

• npm run serve.w - Start server with watch mode

~$ npm run serve.w

• npm run build - Prepare project to Cloud

~$ npm run build

• npm run test-dev - Execute unit-test

~$ npm run teste-dev

• npm run test-dev-watch - Execute unit-test with watch mode

~$ npm run teste-dev-watch

Features

List of features ready and TODOs for future development

• JWT

To-do list:

• Coverage test model mongoose
• Coverage test auth.controller
• Coverage test JWT

Status

Project is: continuous

Contact

Created by @douglaslira - feel free to contact me!