webapp/README.md

64 lines
1.6 KiB
Markdown
Raw Normal View History

2023-02-10 09:40:44 +00:00
## How to start
2024-06-24 17:50:27 +00:00
Use Bun to manage packages.
2023-02-10 09:40:44 +00:00
```
2024-06-24 17:50:27 +00:00
bun i
2023-02-10 09:40:44 +00:00
```
2022-11-27 18:36:45 +00:00
2024-06-19 01:02:05 +00:00
## Useful commands
run checks
2023-02-10 09:40:44 +00:00
```
2024-06-24 17:50:27 +00:00
bun run typecheck
2023-02-10 09:40:44 +00:00
```
2024-02-05 08:59:21 +00:00
fix styles, imports, formatting and autofixable linting errors:
```
2024-06-24 17:50:27 +00:00
bun run fix
2022-09-09 11:53:35 +00:00
```
2024-06-19 01:02:05 +00:00
## Config of variables
- All vars are already in place and wroted in
```
/src/utils/config.ts
```
# End-to-End (E2E) Tests
This directory contains end-to-end tests. These tests are written using [Playwright](https://playwright.dev/)
## Structure
- `/tests/*`: This directory contains the test files.
- `/playwright.config.ts`: This is the configuration file for Playwright.
## Getting Started
Follow these steps:
1. **Install dependencies**: Run `pnpm e2e:install` to install the necessary dependencies for running the tests.
2. **Run the tests**: After using `pnpm e2e:tests`.
## Additional Information
2024-06-19 01:10:27 +00:00
If workers is no needed use:
- `npx playwright test --project=webkit --workers 4`
2024-06-19 01:02:05 +00:00
For more information on how to write tests using Playwright - [Playwright documentation](https://playwright.dev/docs/intro).
## 🚀 Tests in CI Mode
Tests are executed within a GitHub workflow. We organize our tests into two main directories:
- `tests`: Contains tests that do not require authentication.
- `tests-with-auth`: Houses tests that interact with authenticated parts of the application.
🔧 **Configuration:**
Playwright is configured to utilize the `BASE_URL` environment variable. Ensure this is properly set in your CI configuration to point to the correct environment.
📝 **Note:**
After pages have been adjusted to work with authentication, all tests should be moved to the `tests` directory to streamline the testing process.