Local Environment Setup and Maintenance

This project contains a collection of scripts to use a maintenance container to setup and maintain a local environment for development.

Environment First-Time Setup

To set up a local development environment, run these commands from anywhere in repo:

Build and run the containers: docker compose up --detach --build
To setup the apps: docker compose run --rm maintenance bash setup.sh
Next you can log in:
- For testing admin accounts:
  1. Navigate to http://localhost:8000/login
  2. Enter [email protected] as the "User/subject" (the "Claims" input can be left blank, and there is no password)
  3. Navigate to http://localhost:8000/admin/dashboard
- For testing applicant accounts:
  1. Navigate to http://localhost:8000/en/login-info
  2. Click on "Continue to GCKey and sign in"
  3. Enter [email protected] as the "User/subject" (the "Claims" input can be left blank, and there is no password)
  4. Navigate to http://localhost:8000/en/talent/profile

Environment Maintenance

To refresh each sub-project after they have been setup run one of the refresh scripts:

docker compose run --rm maintenance bash refresh_api.sh
docker compose run --rm maintenance bash refresh_frontend.sh

Or refresh all of them in order:

docker compose run --rm maintenance bash refresh_all.sh

Working on UI

In order to compile and render UI for development, you have two options:

log into the local UI using the steps above
run Storybook to view individual components

Logging into the UI

Navigate to the app you'd like to work on (e.g. cd apps/web)
Run pnpm run watch
Allow the first compile to happen
Make some changes, watch it recompile, and refresh your page

Running Storybook

Navigate to the app you'd like to work on (e.g. cd apps/web)
Run pnpm run storybook
Allow the first compile to happen
Make some changes, watch it recompile, and your Storybook page should automatically refresh

Tip

Having trouble with Storybook .cache permissions? Try running sudo chmod 777 -R node_modules/.cache from the relevant workspace.