Boilerplate for a (Node.js based) API or web service.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
configs
dockers
logs
server
.editorconfig
.eslintignore
.eslintrc
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
Makefile
README.md
commitlint.config.js
package.json
yarn.lock

README.md

API Boilerplate

Build Status Coverage Status

Boilerplate for a (Node.js based) API or web service.

How to use

Copy whatever you need.

What's included/used

Docker boxes

See /dockers/README.md.

Modules

# Core
yarn add bluebird debug
# Config
yarn add env-var-defaults
# Core Loopback
yarn add loopback loopback-extended-lib
# Core Middlewares
yarn add helmet serve-favicon strong-error-handler strong-remoting
# Loggers
yarn add bunyan bunyan-debug-stream bunyan-logger express-bunyan-logger syslog-bunyan-logger
# DB / Datasource
yarn add loopback-connector loopback-datasource-juggler
# Mixins
yarn add loopback-ds-timestamp-mixin
# Tools
yarn add http-errors uuid
# Lint
yarn add --dev eslint eslint-config-wcl-backend
# Dev
yarn add --dev coveralls istanbul mocha nodemon should supertest

Commit

Use commitlint with @commitlint/config-conventional for commit lint.

How to create changelog

npm install -g conventional-changelog-cli

Workflow with npm version:

  1. Make changes
  2. Commit those changes
  3. Pull all the tags
  4. Run the npm version [path|minor|major] command
  5. Push

Enable verbose trace log

see: https://github.com/Wiredcraft/api-boilerplate/issues/54

VERBOSE_TRACE_LOG=true make test