README.md

@make.org/front

• Result pages: ./docs/RESULTS.md
• Accessibility report: ./docs/ACCESSIBILITY.md
• Tracking reference: ./docs/TRACKING.md

Before starting

💂‍♂️ Access to make.org tech env are restricted through VPN. Check this with make.org tech team before launching these commands.

👌 Check local.makeorg.tech is setted in hosts

Requirements : Please refers to getting started section

Useful docker commands

Please refers to Docker CLI (open in a new tab) and Docker Compose CLI (open in a new tab) commands.

Running dev instances

Dev mode :

$ docker-compose -f docker-compose.dev.yaml --profile=app-dev up -d
# and go to https://localhost:3000

Dev mode with SSR :

$ docker-compose -f docker-compose.dev.yaml --profile=app-ssr up -d
# and go to https://localhost:3000

After changes, you must rebuild your app in docker container :

# get the id of the running container
$ docker ps
# launch the build script in the container
$ docker exec -it CONTAINER_ID yarn workspace @make.org/front build
# Restart the container
$ docker-compose -f docker-compose.dev.yaml up -d --profile=app-ssr restart

Running functional tests

Start test environment

$ docker-compose -f docker-compose.dev.yaml --profile=front-test up -d

Run all tests

$ yarn cypress:front:run

or open Cypress

$ yarn cypress:front:open

Configure Cypress : cypress.json

i18n

Check translations

$ yarn workspace @make.org/front translation

List unused keys in translation files

$ yarn workspace @make.org/front translation:unused-keys -d ./i18n -l fr
$ yarn workspace @make.org/front translation:unused-keys -d ./client/pages/Static/i18n -l fr

List keys without translation in code

$ yarn workspace @make.org/front translation:orphan-keys -d ./client/pages/Static/i18n -d ./i18n -l fr

This scripts uses grep command. A linux system is require.

Tracking documentation

Check tracking documentation

$ yarn workspace @make.org/front documentation

Accessibility

Run accessibility test:

yarn workspace @make.org/front accessibility

Fix accessibility:

yarn workspace @make.org/front accessibility:fix

Environment variables for production

Create a new .env file.

See .env.local for usage.

Updating packages

Lerna Update Wizard is installed to manage packages across workspaces.

$ yarn lernaupdate