开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

Amida API Boilerplate

Overview

This is a boilerplate application for building REST APIs in Node.js using ES6 and Express. Intended for use with PostgreSQL using Sequelize ORM.

Features

• CORS support via cors
• Uses http-status to set http status code. It is recommended to use httpStatus.INTERNAL_SERVER_ERROR instead of directly using 500 when setting status code.
• Has .editorconfig which helps developers define and maintain consistent coding styles between different editors and IDEs.

Getting Started

Install yarn:

npm install -g yarn

Install dependencies:

yarn

Set environment (vars):

cp .env.example .env

Start server:

# Ensure that a PostgreSQL database is running on your localhost

# Start server
yarn start

# Selectively set DEBUG env var to get logs
DEBUG=amida-api-boilerplate:* yarn start

Tests:

# Run tests written in ES6
yarn test

# Run test along with code coverage
yarn test:coverage

# Run tests on file change
yarn test:watch

Lint:

# Lint code with ESLint
yarn lint

# Run lint on any file change
yarn lint:watch

Other gulp tasks:

# Wipe out dist and coverage directory
gulp clean

# Default task: Wipes out dist and coverage directory. Compiles using babel.
gulp

Deployment

# compile to ES5
1. yarn build

# upload dist/ to your server
2. scp -rp dist/ user@dest:/path

# install production dependencies only
3. yarn --production

# Use any process manager to start your services
4. pm2 start dist/index.js

Logging

Universal logging library winston is used for logging. It has support for multiple transports. A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console for simplicity, you can configure more transports as per your requirement.

API logging

Logs detailed info about each api request to console during development.

Error logging

Logs stacktrace of error to console along with other details. You should ideally store all error messages persistently.

Code Coverage

Get code coverage summary on executing yarn test:coverage

yarn test:coverage also generates HTML code coverage report in coverage/ directory. Open lcov-report/index.html to view it.

Docker Deployment

Docker Compose:

# In `.env` file, assign `UNIQUE_NAME_PG_HOST` to amida-db
1. sed -i s/localhost/amida-db/ .env

# Run:
2. yarn build && docker-compose up

AWS Deployment

The basic steps for deploying to AWS are:

1. Run the Packer script, template.json
2. Run the Terraform script.

Further details can be found in the deploy directory.