README.md

NodeJS Example API

Based on https://github.com/simonrenoult/nodejs-application-architecture

Description

• backed by SQL store

  • SQLite3 in dev
  • Postgres in prod (not tested) - use env var DATABASE_URL

• documented using Swagger:

  • Swagger UI available at /api-docs
  • Swagger JSON API spec available at /api-docs.json

Instructions

Start

Server will listen on port 3000 by default (can be overridden with environment variable PORT)

$ yarn start

Test

$ yarn test

Lint

$ yarn run lint

License

MIT License

Copyright (c) 2018 Stefan Tertan.