Skip to content

Environment Setup

To initialize the Aliquest platform on your local device to begin development, follow these steps:

  1. Github account
    1. You must have a GitHub account in order to develop for this project. It is recommended you setup an SSH key as your authentication method.
  2. You also must join the RMIT-P000420SE GitHub organisation (github.com/RMIT-P000420SE). Ask one of our team members for an invite.
  3. Clone repositories
    1. NOTE: If you wish to use the Project Manager VSCode extension to swap projects, the recommended clone path is ~/git/rmit/
    2. Install the GitHub CLI: github.com/cli/cli/blob/trunk/docs/install_linux.md
    3. Or on windows: winget install --id GitHub.cli
    4. Then run gh auth login to authenticate
    5. In Git bash/bash, run this snippet to clone all repostories
    6. gh repo list RMIT-P000420SE --limit 4000 | while read -r repo _; do
    gh repo clone "$repo" "$repo"
done
  4. Install relevant development dependencies
    1. Node: nodejs.org/en/download
    2. UV: docs.astral.sh/uv/getting-started/installation/
  5. cd RMIT-P000420SE
  6. code .
  7. Initialise each repository and switch to the feature branch
    1. cd aliQuest-backend; git switch feature --no-guess; cd ..
    2. cd aliQuest-docs; git switch feature --no-guess; uv sync; cd ..
    3. cd aliQuest-frontend; git switch feature --no-guess; npm i; cd ..
    4. cd dev-git-ops; git switch feature --no-guess; cd ..
  8. Copy the contents from the .vscode directory located in the documentation project into this root directory
    1. To setup launch configurations, rename the launch-{YOUR OS}.json file to launch.json. Optionally delete the other launch.json file(s).
    2. You will then be able to use Debug: Select and Start Debugging from the command palette
  9. Install the recommended extensions by clicking "Install All" on the popup, or manually searching for each extension in extensions.json in the marketplace

Project setup

  1. Set up project manager projects
    1. Open the command palette and run the Project Manager: Edit Projects command
    2. Override or append the projects in aliQuest-docs/.vscode/projects.json onto the opened file
    3. Open the main AliQuest project by running Project Manager: List Projects to Open in New Window in the command palette, and selecting the RMIT-P000420SE option