atjhoendz/nodejs-rest-api-advanced

a nodejs project exploration

NodeJS REST API Advanced

A project exploration to create rest api in advanced with nodejs. It will be a long-term development with flexible features.

Table Of Content

• NodeJS REST API Advanced
  • Table Of Content
  • Development
    • Prerequisites
    • Running the service
  • API Documentation
  • Features

Development

Prerequisites

- Docker
- Docker Compose

Running the service

# DEVELOPMENT

# build image then run with logs 
$ make build_run_logs_api_dev

# stop service
$ make stop


# DATABASE

# init database table
$ make init_db_dev

# drop all table
$ make drop_db_dev

# refresh db
$ make refresh_db_dev

API Documentation

API Docs Link

Features

• Docker Environment
• Database PostgreSQL
• Pure SQL doesn't use ORM (main branch)
• End to End Testing Using Jest & Supertest
• Integrate Testing with TravisCI
• Caching data with Redis
• Elasticsearch
• Sync PostgreSQL with Elasticsearch