Skip to content

Developer guide

In this section of the documentation, we aim to onboard developers onto the process of setting up a developer workstation, understanding the system architecture, contributing back to the project and so forth. Here is a brief overview of the content provided here:

  • Architecture: Here we outline the system architecture using ER Diagrams, Software Component Diagrams etc.
  • Prerequisites: An overview of the software that needs to be installed before you can start.
  • Cloning: In this section we cover how to make a local working copy on your own machine.
  • IDE Setup: Here we walk through setting up your IDE.
  • Building: This covers tasks related to building the application so you can test it in your browser.
  • Configuration: This covers standard configuration tasks that need to be done once the site is brought online.
  • Design: This section describes the visual design approach for the user interface.
  • Workflows: Examples of typical workflows for adding features, fixing bugs etc.
  • Testing: This section focuses on setting up end-to-end testing for the project.