diff --git a/README.md b/README.md index d7e04da..b2dcf9a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ - ๐Ÿ’ƒ Using TypeScript, hooks, Vite, and other parts of a modern frontend stack. - ๐ŸŽจ [Chakra UI](https://chakra-ui.com) for the frontend components. - ๐Ÿค– An automatically generated frontend client. + - ๐Ÿงช [Playwright](https://playwright.dev) for End-to-End testing. - ๐Ÿฆ‡ Dark mode support. - ๐Ÿ‹ [Docker Compose](https://www.docker.com) for development and production. - ๐Ÿ”’ Secure password hashing by default. diff --git a/frontend/README.md b/frontend/README.md index 7dd453b..13e3a8c 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -115,3 +115,33 @@ The frontend code is structured as follows: * `frontend/src/hooks` - Custom hooks. * `frontend/src/routes` - The different routes of the frontend which include the pages. * `theme.tsx` - The Chakra UI custom theme. + +## End-to-End Testing with Playwright + +The frontend includes initial end-to-end tests using Playwright. To run the tests, you need to have the Docker Compose stack running. Start the stack with the following command: + +```bash +docker compose up -d +``` + +Then, you can run the tests with the following command: + +```bash +npx playwright test +``` + +You can also run your tests in UI mode to see the browser and interact with it running: + +```bash +npx playwright test --ui +``` + +To stop and remove the Docker Compose stack and clean the data created in tests, use the following command: + +```bash +docker compose down -v +``` + +To update the tests, navigate to the tests directory and modify the existing test files or add new ones as needed. + +For more information on writing and running Playwright tests, refer to the official [Playwright documentation](https://playwright.dev/docs/intro). \ No newline at end of file