chore: docs and tests improvements
This commit is contained in:
@@ -7,11 +7,23 @@ Ensure you have the following installed on your system:
|
||||
- [Python](https://www.python.org/) (>=3.10,<3.12)
|
||||
- [uv](https://docs.astral.sh/uv/)
|
||||
- [Docker](https://www.docker.com/)
|
||||
- [Docker compose](https://docs.docker.com/compose/)
|
||||
- [Docker compose](https://docs.docker.com/compose/) (latest versions)
|
||||
|
||||
## Warning
|
||||
|
||||
Plese note that containers will use ports 13241 to 13245 and 8080, so there is must be no listeners on this ports range.
|
||||
Plese note that containers will use ports from 13241 to 13245 and 8080, so there is must be no listeners on this ports range.
|
||||
|
||||
## Clone the project
|
||||
|
||||
```bash
|
||||
git clone https://gitlab.prodcontest.ru/2025-final-projects-back/devitq.git
|
||||
```
|
||||
|
||||
## Go to the project directory
|
||||
|
||||
```bash
|
||||
cd devitq/solution/tests/e2e
|
||||
```
|
||||
|
||||
## Install dependencies
|
||||
|
||||
@@ -19,12 +31,20 @@ Plese note that containers will use ports 13241 to 13245 and 8080, so there is m
|
||||
uv sync --no-dev
|
||||
```
|
||||
|
||||
### Customize environment
|
||||
## Customize environment
|
||||
|
||||
Customize environment with `docker run` command (or bind .env file to container), for all environment vars and default values see [.env.template](./.env.template).
|
||||
```bash
|
||||
cp .env.template .env
|
||||
```
|
||||
|
||||
And setup env vars according to your needs.
|
||||
|
||||
## Run tests
|
||||
|
||||
```bash
|
||||
uv run pytest .
|
||||
```
|
||||
|
||||
## Results
|
||||
|
||||
You will see something like `n passed in Ns`
|
||||
|
||||
@@ -21,7 +21,6 @@ def docker_compose() -> Generator[None]:
|
||||
"docker",
|
||||
"compose",
|
||||
"down",
|
||||
"-v",
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user