README.md

CVE-API

Table of contents

• Technologies
• Style Guidelines
• Directory Layout
• Setup
• API Documentation
• Unit Testing

Technologies

This project uses or depends on software from

• NodeJS https://nodejs.org/
• Express https://github.com/expressjs
• MongoDB
• PM2 http://pm2.keymetrics.io/
• Mongoose.js https://mongoosejs.com

Style Guidelines

This project uses the following Style Guidelines

• https://github.com/standard/standard

Directory layout

Top Level Directory

.
├── src                     # Source files (This is where the API resides)
├── test                    # Automated tests (This is where the API tests reside)
├── LICENSE
└── README.md               

Src Directory

.
├── ...
├── src                     # Source files (This is where the API resides)
│   ├── controller/         # All API logic resides here.
│   ├── model/              # All Mongoose Schemas, models, and database logic.
│   ├── middleware/         # Authentication middleware resides inside this folder. 
│   ├── routes.config.js    # This is where routes get created and get tied back to their specific controller. 
│   └── index.js            # Where everything begins.
└── ...

Setup

Step 1. Install required node modules

This assumes the latest node and npm are installed.

cd cve-services
npm install

Step 2. Setup and start MongoDB locally

Install MongoDB locally

• https://docs.mongodb.com/manual/administration/install-community/

Download MongoDB Compass (MongoDB GUI)

• https://www.mongodb.com/download-center/compass

Step 3. Start the node application

In order to start a dev enviorment:

npm run start:dev

Unit Testing

This project uses the following for unit testing

• https://mochajs.org/
• https://www.chaijs.com/

Before running the unit tests, change the NODE_ENV variable in the .env file from dev to test.

Use the following command to run the unit tests:

npm run start:test

In order to view server logs and to stop server

To view logs:

pm2 logs

To stop the server

pm2 stop all