CORD API v3

Description

Bible translation project management API.

Setup

1. Install Neo4j Desktop
2. Create a new database using the Neo4j Desktop GUI with the username and password shown in the environment variables below
3. Click the plugins tab on the new database management view and add the APOC plugin
4. Start the database
5. Set enironment variables:

export NEO4J_URL=bolt://localhost
export NEO4J_USERNAME=neo4j
export NEO4J_PASSWORD=asdf
export JWT_AUTH_KEY=asdf

You will also need the following environment variables set: get values from the team

export AWS_SECRET_ACCESS_KEY=
export AWS_ACCESS_KEY_ID=
export FILES_S3_BUCKET=

Usage

Install:

1. brew install gcc
2. npm install -g node-gyp
3. CXX=g++ yarn install argon2
4. yarn

See argon2 for more info on installing argon2.

Develop: yarn run start:dev
Test: yarn run test:e2e
Create new model class: nest g class model/className --no-spec
Create new resolver: nest g resolver components/className --no-spec
Create new service: nest g service components/className --no-spec

License

CORD is MIT licensed.