Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Welcome

Welcome! You must be baffled by the project, not having any clear idea as you just joined. Dread not! We'll walk you through the onboarding.

...

By all means, please feel free to to ask on Slack general channel!

Understanding the structure of 2 workflows and 5 teams

The project is divided into 2 workflows: online and offline

...

In one word, infra team underlies all other teams.

Workflows and envs

Now having a rough idea about each team's role, let's understand how their code is interacting with each other (workflows) and 3 envs.

...

Project environment and workflow settings

Codebases (GitHub)

You can find a list of all codebases on GitHub for each team at this link.

GitHub repos

How do I write/debug code?

After cloning your codebase from GitHub, now it's time to write/debug code.

...

Read the doc below to know how.

Dev/Debug in Container

Where are these 3 envs? (dev, test, prod)

The previous section "Workflows" shows 3 envs (dev, test, prod) in the diagram. Where are they?

...

Domains of backend APIs and SSL

Deploy your code

Once you have implemented new features locally and pushed your code to the GitHub repo, you can deploy your changes on the test env to see if they integrate well with other components of the project. After making sure that everything works well, it's time to deploy the new feature on the prod env and have it accessible to all our users!

Read the doc below for instructions on how to deploy.

Deploy Services on AWS

Access databases

During your development, you might want to connect to our databases to view/modify the data. For data security reasons, databases are host differently for different environments. Our development and test databases are hosted on MongoDB Atlas and our production database is hosted on BioHPC.

Connection strings to the databases and set-up instructions are given in the doc below.

BioHPC and MongoDB Atlas Set-up