/
Onboarding!

Onboarding!

Owned by Peter Derias (Unlicensed)
Last updated: Sept 14, 2022
2 min read

Hi!!!!!

Welcome to Circles. I hope we can have a great year developing together. Here is a checklist for what you would need to do to get up to pace.

Please come to Peter or Gabriel if you run into issues!

Set up

  1. Docker:
    Install Docker Desktop. This is the simplest method to get docker/docker-compose onto your system
    (note: if youre using windows, please use WSL to run circles. Running it on windows may be a pain in the ass)
    Docker Desktop
    also, download the docker extension for your IDE
    https://code.visualstudio.com/docs/containers/overview

  2. Make sure python is at least on version 3.10, and install stuff using requirements.txt

  3. Make sure you have node and npm (which comes with node) installed, as well as (optionally) the node virtual manager (nvm).
    https://nodejs.org/en/
    https://github.com/nvm-sh/nvm#install--update-script

    node is necessary to run the front-end, and nvm will help you easily switch between versions of node. After this, you can run npm install.

  4. After filling in the env files as directed by backend/readme.md or frontend/readme.md, you can now run the app using run_app.py!

  5. Make sure you can run also the dockerised version of the app!

    Please refer to the README.md at https://github.com/csesoc/Circles/blob/dev/frontend/README.md for details on how to run.

Understand

Please watch these videos made by Peter and Sano (previous FE lead) about the main concepts in both the frontend and backend. Even if you are assigned to one team, please watch both as we need all devs to have a baseline understanding on how it works

NOTE: These videos may be out of date as the codebase changes overtime but it may be relevant.

https://youtu.be/FAIcjAIf5_w

Frontend Overview - Circles

Workflow

  • Please read the following docs to familiarise yourself with our project workflow:

Start!

Please look at the board and pick up cards labeled “good first issue“ or “onboarding.“ These may look a little boring, but they are designed to help you wrap your head around main concepts. Also, it is quite clear when they are implemented, so its nice in that way. Your leads should start assigning you some onboarding tickets!

 

Related content