Graph database-driven API for site of theatrical productions, materials, and associated data.
- 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 clean-install - Copy development environment variables from
.env-devinto.envby 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)
- Download the Neo4j Desktop 2 app (the version of the Neo4j image in
docker/docker-compose.ymlwill be a compatible version) - Create a local Neo4j graph database, configuring as to:
- Neo4j user name matches
.envDATABASE_USERNAMEvalue- For local instances this will be
neo4j, which can be verified by viewing theusernamevalues returned by this Cypher query:CALL dbms.listConnections()
- For local instances this will be
- Neo4j local graph database password matches
.envDATABASE_PASSWORDvalue .envDATABASE_URLvalue is endpoint on which Neo4j local graph database is running- The connection URI is viewable on the Neo4j Desktop 2 app by navigating to the applicable database and then:
…→Overview
- The connection URI is viewable on the Neo4j Desktop 2 app by navigating to the applicable database and then:
- Neo4j user name matches
Note
Should you encounter Neo4jError: There is not enough memory to perform the current task when seeding the database then perform the following steps:
- Open the Neo4j Desktop 2 app
- For the applicable database, click
…→Open→neo4.conf(opening with a text editor), then increase the memory allocation, e.g.server.memory.heap.initial_size=512m→server.memory.heap.initial_size=5000mserver.memory.heap.max_size=1G→server.memory.heap.max_size=2G
- Save the file (and re-start the database instance if running)
- Open the Neo4j Desktop 2 app
- Press
►for the applicable database
- Run local Neo4j graph database
- Run server using
$ npm start - Visit routes via
http://localhost:3000(e.g.http://localhost:3000/productions)
- Ensure that a local instance of Neo4j graph database and app are running
- Run
$ npm run seed-db
- Run a local instance of
dramatis-cmsonhttp://localhost:3001, which will point at this API on port 3000
- Run a local instance of
dramatis-spa(single-page application) onhttp://localhost:3002, which will point at this API on port 3000
or
- Run a local instance of
dramatis-ssr(server-side rendered) onhttp://localhost:3003, which will point at this API on port 3000
$ npm run lint-check
$ npm run unit-test
$ npm run int-test
- Download and run the Docker Desktop app
- Stop any Neo4j databases running on the Neo4j Desktop 2 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-resourcesand 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
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
Using venue model as an example.
- Get data required to prepare new venue
- Create venue
- Requires body, e.g.
{ "name": "National Theatre" }
- Get data required to edit specific venue
- Update specific venue
- Requires body, e.g.
{ "name": "Almeida Theatre" }
- Delete specific venue
- Show specific venue
- List venues
dramatis-cms manages the content.
---
config:
theme: base
themeVariables:
actorBkg: "#E6E6E6"
actorBorder: "#808080"
actorTextColor: "#000000"
---
sequenceDiagram
%% Components and grouping boxes
actor CLIENT as Client
box rgb(245, 223, 238) CMS
participant DRAMATIS_CMS as dramatis-cms
end
box rgb(218, 231, 242) API
participant DRAMATIS_API as dramatis-api
end
box rgb(223, 240, 216) Database
participant NEO4J_DATABASE as Neo4j database
end
%% Relationships
CLIENT ->> DRAMATIS_CMS: GET/POST/PUT/DELETE request
DRAMATIS_CMS ->> DRAMATIS_API: GET/POST/PUT/DELETE request
DRAMATIS_API ->> NEO4J_DATABASE: CRUD operation
NEO4J_DATABASE -->> DRAMATIS_API: Return data
DRAMATIS_API -->> DRAMATIS_CMS: Return data
DRAMATIS_CMS -->> CLIENT: Return data
dramatis-spa visualises the content.
---
config:
theme: base
themeVariables:
actorBkg: "#E6E6E6"
actorBorder: "#808080"
actorTextColor: "#000000"
---
sequenceDiagram
%% Components and grouping boxes
actor CLIENT as Client
box rgb(216, 240, 236) SPA
participant DRAMATIS_SPA as dramatis-spa
end
box rgb(218, 231, 242) API
participant DRAMATIS_API as dramatis-api
end
box rgb(223, 240, 216) Database
participant NEO4J_DATABASE as Neo4j database
end
%% Relationships
CLIENT ->> DRAMATIS_SPA: GET data
DRAMATIS_SPA ->> DRAMATIS_API: GET data
DRAMATIS_API ->> NEO4J_DATABASE: Retrieve data
NEO4J_DATABASE -->> DRAMATIS_API: Return data
DRAMATIS_API -->> DRAMATIS_SPA: Return data
DRAMATIS_SPA -->> CLIENT: Return data
dramatis-ssr visualises the content.
---
config:
theme: base
themeVariables:
actorBkg: "#E6E6E6"
actorBorder: "#808080"
actorTextColor: "#000000"
---
sequenceDiagram
%% Components and grouping boxes
actor CLIENT as Client
box rgb(237, 223, 211) SSR
participant DRAMATIS_SSR as dramatis-ssr
end
box rgb(218, 231, 242) API
participant DRAMATIS_API as dramatis-api
end
box rgb(223, 240, 216) Database
participant NEO4J_DATABASE as Neo4j database
end
%% Relationships
CLIENT ->> DRAMATIS_SSR: GET data
DRAMATIS_SSR ->> DRAMATIS_API: GET data
DRAMATIS_API ->> NEO4J_DATABASE: Retrieve data
NEO4J_DATABASE -->> DRAMATIS_API: Return data
DRAMATIS_API -->> DRAMATIS_SSR: Return data
DRAMATIS_SSR -->> CLIENT: Return data