Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 2.49 KB

README.md

File metadata and controls

103 lines (73 loc) · 2.49 KB
Raw

Liflig baseline for web apps

This project serves as a baseline when you wish to create a new webapp which is a single page application.

Technologies

  • React for components
  • Typescript for type safety
  • React-router for routing
  • Vite for bundling
  • Vitest for unit testing
  • Playwright for e2e and visual testing
  • Eslint and prettier for linting
  • Renovate for automatic updates of dependencies
  • GitHub Actions for building and testing application in CI

Checklist if using this baseline as a template

  • Replace references to baseline in README.md and update with relevant project information
  • Consider removing license from package.json and the file LICENSE
  • Replace name and description in package.json
  • Search code for TODO and replace as needed
  • Remove irrelevant parts from this README (such as this section)

Contributing

Pre-commit checklist

All of these will be run as part of CI tests, so it is possible to save some time by pushing and let the CI server try this out, and instead handle any failure situations.

  1. Lint check

    npm run lint

  2. Test

    npm run test

  3. Build

    npm run build

  4. Run Playwright tests (see separate section for more details)

    ./test-playwright-docker.sh

Running webapp locally

Install dependencies:

npm ci
# or use `npm install` if changing dependencies

Run the development server:

npm start

Browser testing

The project uses Cypress for browser testing.

Some of our Playwright tests verify screenshots. For this to work properly, fonts must be exactly the same on the machine running Cypress as in the CI environment. The script test-cypress-docker.sh simulates this:

./test-playwright-docker.sh --update

The --update argument will cause failing image snapshots to be replaced. Inspect the updated snapshot before commiting it.

To run tests in interactive mode (opens a browser window):

npm run test:e2e:ui

Deployment

The webapp in this repo is deployed with https://github.com/capralifecycle/liflig-cdk-app-reference to:

It is used as an example for pipeline. Note that the environment detection relies on specific URLs and hence is not currently working properly for these URLs.