/theatrebase-api

Graph database-driven API for site of theatrical productions, materials, and associated data

Primary LanguageJavaScriptOtherNOASSERTION

theatrebase-api CircleCI

Graph database-driven API for site of theatrical productions, materials, and associated data.

Setup

  • Clone this repo
  • Set Node.js to version specified in .nvmrc, which can be achieved by running $ nvm use (if using Volta then it will be set automatically)
  • Install Node.js modules: $ npm install
  • Compile code: $ npm run build
  • Copy development environment variables from .env-dev into .env by running command $ npm run transfer-env-dev; N.B. values may need to be amended to match your specific local database configuration (see: Database setup)

Database setup

  • Download the Neo4j Desktop app (the version of the Neo4j image in docker/docker-compose.yml will be a compatible version)
  • Create a local Neo4j graph database, configuring as to:
    • Neo4j user name matches .env DATABASE_USERNAME value
    • Neo4j local graph database password matches .env DATABASE_PASSWORD value
    • .env DATABASE_URL value is endpoint on which Neo4j local graph database is running
    • N.B. Neo4j user name and Neo4j local graph database endpoint can be viewed via the Desktop app by running the local Neo4j graph database, then launching the Neo4j Browser and viewing its connection status, which is displayed upon opening the browser and can be returned via browser command :server status)

To run local Neo4j graph database

  • Open Neo4j Desktop app
  • Press ► Start for requisite database

To run locally

  • Run local Neo4j graph database
  • Run server using $ npm start
  • Visit routes via http://localhost:3000 (e.g. http://localhost:3000/productions)

To seed database

  • Ensure that a local instance of Neo4j graph database and app are running
  • Run $ npm run seed-db

To edit content via CMS (content management system) (locally)

  • Run a local instance of theatrebase-cms on http://localhost:3001, which will point at this API on port 3000

To view content via user interface (locally)

  • Run a local instance of theatrebase-spa (single-page application) on http://localhost:3002, which will point at this API on port 3000

or

  • Run a local instance of theatrebase-ssr (server-side rendered) on http://localhost:3003, which will point at this API on port 3000

To run linting checks

  • $ npm run lint-check

To run unit tests

  • $ npm run unit-test

To run integration tests

  • $ npm run int-test

To run end-to-end tests

  • Download and run the Docker Desktop app
  • Stop any Neo4j databases running on the Neo4j Desktop app if they share the same port number as that used by the Docker-served Neo4j instance
  • Start the Docker-served resources by running $ npm run e2e-test-resources and wait until they are ready
  • In a separate CLI tab run $ npm run e2e-test
  • The Docker-served Neo4j database can be queried via the Neo4j browser by visiting http://localhost:7474

A note on data used for tests

For the purposes of providing focused and sufficient test coverage, the data used for tests is a mixture of:

  • real data, e.g. entirely from a real-life production
  • real data with contrived elements, e.g. a real-life play whose credits include made-up entities
  • wholly contrived data, e.g. a made-up awards ceremony that nominates made-up entities

Endpoints

Using venue model as an example.

GET /venues/new

  • Get data required to prepare new venue

POST /venues

  • Create venue
  • Requires body, e.g. { "name": "National Theatre" }

GET /venues/:uuid/edit

  • Get data required to edit specific venue

PUT /venues/:uuid

  • Update specific venue
  • Requires body, e.g. { "name": "Almeida Theatre" }

DELETE /venues/:uuid

  • Delete specific venue

GET /venues/:uuid

  • Show specific venue

GET /venues

  • List venues