Skip to content

README.md

Latest commit

 

History

History
31 lines (16 loc) · 1.03 KB

README.md

File metadata and controls

31 lines (16 loc) · 1.03 KB
Raw

Code Test: Node

A simple Express app designed to provide a basic API for our code test.

Requirements

  • Node (10+) or an environment like Docker (see below)

Setup

  1. Run npm install to install dependencies (skip this step if using Docker)

  2. Run npm run migrate to migrate your development database

  3. Run npm run seed to seed your development database

  4. Run npm start to start up the local development server (skip this step if using Docker)

You should get JSON output from http://localhost:3000/members

Testing

Run npm test to run the test suite.

Docker

As an alternative to installing node directly, you can use the provided Docker files to run the app and test suite.

Run docker-compose up -d to start the Docker container, then run the Setup tasks above, prepending docker-compose exec web to the command (e.g. docker-compose exec web npm run migrate)

Changes to the app code may require restarts to the node process. To do so, run docker-compose restart