simple-task-service

A companion piece to the Loopback-based Task Service example;

Getting Started

Dependencies:

docker
NodeJS
npm run install
cp env.example .env && cp env.example .env.test

Unlike the loopback version, there is no OpenAPI explorer at http://localhost:3000/explorer, however the basic api interfaces are the same:

You can import this Postman Collection (you will need to update the authorization headers)

GET /v1/stats
GET /v1/user/whoami
POST /v1/user/create
POST /v1/user/login

GET /v1/task
GET /v1/task/:id
POST /v1/task
PUT /v1/task/:id
DELETE /v1/task/:id

Testing

Run the integration tests

The integration tests will automatically stand up an environment using docker-compose, test the api itself using supertest, and then bring down the environment and destroy the volumes.

npm run it

Running it

Use can use the command npm run dev, which will automatically create the docker environment, build, and start the application.

Debugging

Start with bringing up the environment with npm run dev:before, and then use the VSCode Launch Program task

mschnee / simple-task-service