API Skeleton

Backend skeleton to serve an API to web-skeleton. Can be easily changed/extended for pretty much anything.

Based on Node.js (12), Koa, and PostgreSQL (>10).

Installation

Having Node.js, and Yarn already installed:

yarn

Initialization

Probably the easiest way to start a fresh local DB for development, is to just use a Docker image:

docker run --name api-pg -e POSTGRES_USER=api -e POSTGRES_PASSWORD=api -p 5432:5432 -d postgres:10-alpine

Such DB can be easily viewed using another docker image:

docker run -p 8081:8081 --link api-pg:pg -e DATABASE_URL=postgres://api:api@pg:5432/api?sslmode=disable --rm sosedoff/pgweb

or by using psql if you have it installed:

psql postgres://api:api@127.0.0.1:5432/api

Create a .env file based on .env.example:

NODE_ENV=development
LOG=5
PORT=3000
DATABASE_URL=postgres://api:api@localhost:5432/api
SERVE_DOCS=true
...

To create the DB and (re)initialize:

yarn db:create
yarn db:reset

Start

After initialization, you can start the application in development mode:

yarn dev

If you want to build the documentation in a separate app:

yarn docs:build && yarn docs:serve:watch