Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.31 KB

README.md

File metadata and controls

60 lines (40 loc) · 1.31 KB
Raw

Motherbrain API

Galvanize staff, student, and cohort API aggregator. Uses:

Technologies

  • Express
  • Passport for Authentication
  • JSONAPI-Serializer for Serialing/Deserializing
  • Knex.js for database migration/seeding
  • Objection ORM
  • Postgres database

Setup

  1. yarn or `npm install
  2. Copy .env.example to .env and replace the values
  3. npm run migrate && npm run seed to populate the database
  4. npm start to run production build
  5. npm run dev to run locally

Testing

  • Mocha/Chai and Sinon for unit and integration testing
  • Supertest for acceptance testing
  1. npm test to run all tests
  2. npm run [test-level] to run individual test levels, where [level] is unit|integration|acceptance
  3. npm run find-test || [search-term] to grep for specific tests

Endpoints

Business Units

  • /api/v1/business-units
  • /api/v1/business-units/:business_unit_id/cohorts
  • /api/v1/business-units/:business_unit_id/cohorts/:cohort_id

Cohorts

  • /api/v1/cohorts/:cohort_id

Standards

  • /api/v1/standards
  • /api/v1/standards/:standard_id

Performances

  • /api/v1/performances
  • /api/v1/performances/:performance_id

Daily Plans

  • /api/v1/daily-plans
  • /api/v1/daily-plans/:daily_plan_id

Instructors

  • /api/v1/instructors
  • /api/v1/instructors/:instructor_id