Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 958 Bytes

README.md

File metadata and controls

40 lines (27 loc) · 958 Bytes

CORD API v3

Description

Bible translation project management API.

Requirements

  1. Docker from their website (complications with homebrew)
  2. NodeJS (brew install node corepack && corepack enable)
  3. Gel (brew install geldata/tap/gel-cli)

Setup

  1. Ensure you meet the NodeJS version requirement found in package.json.
  2. Ensure corepack is enabled corepack enable
  3. Run yarn to install dependencies
  4. Use docker to run the current database (neo4j) locally: docker-compose up -d db.
  5. Setup an Gel instance (the next gen database replacing neo4j)
    gel project init
    yarn gel:gen

Usage

Develop: yarn start:dev
Test: yarn test:e2e

See scripts in package.json for other commands to run

Documentation

NestJS Gel GraphQL

License

CORD is MIT licensed.