@sanctuaryteam/web-app

Pre-requisites

Requires Node.js and Yarn.

Project setup

1. Create a new GitHub personal access token with the following scopes:

   read:packages
   

2. Set env variable SANCTUARYTEAM_AUTH_TOKEN to the token value. You should run cp .env.example .env and modify this new file to store your token.

3. Run

   yarn install

Compiles and hot-reloads for development

yarn dev

Running Docker development

Make sure Docker is installed.

If you are on Windows, you should be running the files from within a WSL container. Otherwise, you will not be able to hot reload and file access will be slow.

1. Start Ubuntu (or the distro you installed with WSL/Docker)
2. Checkout the repositories or copy it from your local filesystem cp -r /mnt/c/Users/username/Documents/sanctuaryteam/ ~/ (your file path may vary)
3. Enter the folder in the command line cd ~/sanctuaryteam/web-app
4. Run the following command to start development:

docker compose up

5. To modify the files on your Windows machine install Remote WSL for VS Code
6. In your WSL instance, run code . inside of the web-app folder.
7. Start VS Code and select the Remote Explorer from the left-hand side, and choose the web-app.

Running commands on Docker service

docker-compose run web-app yarn add my-package --dev

Running dprint

yarn run format

Adding or updating localizations

1. Add localizations in English using the string templating pattern that is throughout the project
2. Run yarn lingui:extract to extract the English words to hashes.
3. Update any localization .json files found in src/modules/common/i18n, this folder is auto-generated.
4. Once you have updated the .json files run yarn lingui:compile.
5. Check in the changes in a PR