Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
49 lines (29 loc) · 2.53 KB

DEVELOPMENT.md

File metadata and controls

49 lines (29 loc) · 2.53 KB

Development

This document describes the development workflow. We are using Turborepo and pnpm.

Managing dependencies

Check the Turborepo docs - make sure you use the pnpm code examples.

Internal packages

packages/react is published to NPM but it is also registered as an internal package. Demo app in apps/react-vite depends on this internal package. This means that it will use the build output of packages/react instead of the published NPM package. If you want to test the changes you just made in packages/react, make sure you run pnpm build from the repo root so that apps/react-vite will read the new build.

E2E tests

Our e2e test suite can be run locally (while developing) and in the CI. These tests only cover the projects in the apps folder. Each project is expected to expose a serve command that serves the already built app on the predefined e2e tests port - 3000.

Verifying email

Our authentiction flows require the end user to receive an email and either follow the link from the email or read a special value (OTP code). In order to test this end to end, we created a Mailinator account for our team. Each email is sent to the same domain, but the local part is unique per test run, allowing us to identify email that resulted from a particular test.

WebAuthn

Not supported yet - we should look into virtual authenticators.

Running e2e tests locally

First make sure all the environment variables are set up - check the packages/tests/.env.example for the reference .env file - create a new .env file based on the example and populate the missing values before running the test.

Build all the projects and then run the test:e2e command with the APP_NAME environment variable specifiyng the app you want to test:

pnpm build
pnpm test:e2e

Please keep in mind this will fail the first time you run the test:e2e command - Playwright will prompt you to install the browser binaries and give you the exact command you need to run.

If you want to run tests step by step in a browser window, pass the --debug flag:

pnpm build
pnpm test:e2e -- --debug

Updating Playwright

@playwright/test in packages/tests/package.json and the Playwright image in Dockerfile need to use the same version!