Generic Fullstack Engineer Code Challenge Datastore

This repo contains code to create a datastore / API for a generic FSE code challenge.

The API can be viewed at https://generic-fse-datastore.herokuapp.com/api/v1/api-docs

The database is deployed on Heroku as
generic-fse-datastore

Data provided by this datastore is consumed by an ApolloGL client / React app.
Code for the ApolloGL client / React app can be found here:
https://github.com/mattburnett-repo/generic-fse-code-challenge

Technologies used

Postgresql
Node / Express
Swagger / OpenAPI
Mocha / Chai / Supertest
Synth test data generator (getsynth.com)

Testing

Tests are located in the test/ folder. They are very basic, and can be improved with edge-case / additional functionality tests.

Run during dev / debug:

npm run test

Run once and exit:

npm run testOnce

Getting started

Install the dependencies

npm install

Create the database following instructions in the 'Database' section, below.

Start the app in dev mode (nodemon)

npm run ts

Database

Create the database by using the Postgresql client of your choice
database name: generic-fse-datastore

The database can be created by running

npm run createDB

Test base data can be created by running

npm run insertBaseData

Test bulk data can be created by running

npm run insertBulkData

Please note that bulk data depends on Synth. Synth will need to be installed on your system.
Templates that Synth requires are located in the db/synthTemplates folder. ] This will generate some warnings in the console. These warnings involve integer type discrepancies, and can be ignored.

Base data provides known/consistent data that helps later with UI testing
Bulk data just provides a lot of extra records to help with UI sorting / pagination functionality

Environment variables

You will need the following .env variables for the database:

DATABASE_USER_NAME=postgres
DATABASE_PASSWORD=postgres
DATABASE_NAME=generic-fse-datastore
DATABASE_HOSTNAME=localhost
DATABASE_PORT=5432

To Do

Everything can always be better.
Columns names could be lowerCamelCase instead of hyphen_format