Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 2.46 KB

README.md

File metadata and controls

66 lines (51 loc) · 2.46 KB
Raw

covidhelphub-backend

Description:

Backend for the backend of the org app for Reach4Help

To start:

  • Before we forget! Create a new .env file in your root folder with the same content as our integration file. This will be used by our integration tests once we have them.
  • Because our backend needs to connect to stuff like a database, etc. You need to install docker in order to start the project.
  • If you're using Mac or Windows you should be good to go, however, if you are using Linux, you must install Docker Compose (already included in the versions for Mac and Windows), a command line tool that builds on top of the Docker Engine and provides a series of useful commands that we are going to be using to start our project.
  • Run yarn build (which runs a simple script) so it builds our docker-compose with all its services (our app and dependencies) and installs every package we need. If you install any new dependency you'll also have to run yarn build again!
  • After the previous steps you should be able to run yarn start, which in turn runs a simple script that aims to make this start up very easy to do.
  • You can check we have two Dockerfiles that describe our service (Dockerfile and Dockerfile.dev). Our start is using Dockerfile.dev which supports hot reload and all that good stuff so we can develop with pleasure!

When the server starts have a go with the GraphQL playground at:

  • http://localhost:4000/

Database Structure

Organizations (has_many Users) (has_many Programs) (has_many Forms)

  • id
  • name

Users (belongs to Organization) (has_many Programs through ProgramAssignments) (Polymorphic child tables: Volunteers, Beneficiaries, Directors, Managers)

  • id
  • name
  • organization_id (foreign_key)
  • request_assignment_id (foreign_key)
  • program_assignment_id (foreign_key)

Programs (has_many Users through ProgramAssignments)

  • id
  • name
  • organization_id (foreign_key)
  • program_assignment_id (foreign_key)

Requests (has_many Users through RequestAssignments)

  • id
  • request_assignment_id

RequestAssignments

  • id
  • volunteer_id (foreign_key to polymorphic Users table)
  • beneficiary_id (foreign_key to polymorphic Users table)
  • request_id (foreign_key)

ProgramAssignments

  • id
  • user_id (foreign_key)
  • program_id (foreign_key)

Forms (belongs_to Organization)

  • id
  • organization_id (foreign_key)