The project is divided into 2 workflows: online and offline
The members are divided into 5 teams: frontend-mobile, frontend-web, backend-online, backend-offline, infra
The table below gives a roughly good idea to understand the relations between 2 workflows and 5 teams
| Workflow | User | Interface (frontend) | API (backend) | database |
|---|---|---|---|---|
| Online | e.g. Parents uploading data/photo | app (iOS, Android) | APIs | Database named "BioHPC" |
| (by frontend-mobile team) | (by backend-online team) | |||
| Offline | e.g. Scientists view data | web (React) | APIs | Should also be on "BioHPC" |
| (by frontend-web team) | (by backend-offline team) |
You might notice infra team is missing in the table. Infra team builds up the environments (servers/GitHub/certs/domains/etc) to support other teams.
In one word, infra team underlies all other teams.
Now having a rough idea about each team's role, let's understand how their code is interacting with each other (workflows).
To understand the workflows, from the link below, read the the last diagram in the bottom
Project environment and workflow settings
You can find a list of all codebases on GitHub for each team at this link.
After cloning your codebase from GitHub, now it's time to write/debug code.
Probably you won't yet have every required library installed, but worry not! We use docker container to standardise everything (versions/libraries).
In one word, you'll find it more convenient and elegant to write/debug code in docker container env (instead of on your laptop's local env).
Read the doc below to know how.
After reading the previous docs "How do I write/debug code?", you will be able to write/debug code locally - that is your dev env! (dev env is on everyone's laptop).
Test env and prod env are NOT on your laptop, but rather shared by all members. Where are they and how can I access them? Here's the answer.
Domains of backend APIs and SSL