chikeozulumba / africave-rest-api

AFRICAVE API

Technologies

• Node.js, Express, Javascript, npm - core platform
• Helmet, compression, cors - common middlewares
• MongoDB, Mongoose - database and schema modeling
• JWT, express-jwt - generate and validate access token
• ESLint - check and fix linting of code
• Jest - unit testing javascript code and api
• Husky - precommit hooks for git

Getting Started

Prerequisites

• Node.js v12.13.1 or higher to support ES2018 syntax.
• MongoDB v3.0.x or higher [more].

Initial Setup

# Clone the repo
$ git clone https://github.com/chikeozulumba/africave-rest-api.git africave-rest-api

# Change directory to newly created one
$ cd africave-rest-api

# Install dependencies
$ npm install

# Setup environment
$ cp .env.example .env

# Start development server
$ npm start

# Watch for file changes
$ npm run start:watch

# Run server in debug mode
$ npm run start:debug

Docker

# Clone the repo
$ git clone https://github.com/chikeozulumba/africave-rest-api.git africave-rest-api

# Change directory to newly created one
$ cd africave-rest-api

# Docker compose
$ docker-compose up

Testing

# Run tests in normal mode
$ npm test

# Run tests in watch mode
$ npm run test:watch

# Generate coverage report for tests
$ npm run test:coverage

Linting

# Lint code using ESLint
$ npm run lint

Docker

# Build docker image
$ docker-compose build

# Start newly built image
$ docker-compose up