Skip to content

Latest commit

 

History

History
123 lines (79 loc) · 2.48 KB

README.md

File metadata and controls

123 lines (79 loc) · 2.48 KB
Raw

🔥 Blazing fire

Pre-requisites

  • Docker
  • Node

Dev environment

The environment is fully containerized within compose.yaml.

A .env file is necessary at the root. An example .env.example file is provided and works out of the box.

Cheat sheet

Install project dependencies

For docker dev container:

docker compose run --rm dev npm install

For the host:

npm install

Note: The node_modules folders on the host and within Docker containers are isolated from each other (explained here).

Manage dependencies

npm install <package> --workspace=workspace1 --workspace=workspace2

Note: Whenever the package lock is updated, the base image must be rebuilt for these changes to take effect.

docker compose build

Run the dev env

Run all the services (supabase, db...)

docker compose --profile dev up -d

Tip: Set the COMPOSE_PROFILES=dev environment variable locally.

docker compose run --rm -P dev

Web app will be accessible at localhost:3001

If there are changes in dependencies, rebuild the dev container:

docker compose build dev
docker compose up dev -d

Test

Tests are created with Playwright and heavily rely on visual snapshot comparaison.

Tests run against a production build app (the web service, with no volumes) at localhost:3000.

If there's any change in the app source code, rebuild the service:

docker compose build web
docker compose up web -d

To run the test

docker compose run --rm test
docker compose run --rm test npx playwright test -u # update snapshots

If tests fail, a report will be available at localhost:9323, as configured by Playwright.

DB

Run these commands from the host. They use shell scripts to leverage environment variables from the .env file used in the Docker composition.

npm run db:dump # dump the current state of the DB to a static file
npm run db:reset # restore the current dump from that file
npm run db:types # generated TS typing for better DX

To erase the data, remove the DB volume.

docker compose down db -v

Update Supabase project

Prerequisite: Ensure the Supabase project is linked.

npx supabase link --project-ref <project-ref>

Check migration status on the remote project

npx supabase migrations list

Push local migrations to remote

npx supabase db push