Skip to content

Commit

Permalink
docs: Remove run test documentation from README.md to move them to th…
Browse files Browse the repository at this point in the history
…e wiki
  • Loading branch information
drikusroor committed Dec 5, 2023
1 parent bb38eb1 commit bd1d838
Showing 1 changed file with 0 additions and 35 deletions.
35 changes: 0 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,38 +45,3 @@ To stop the containers, press `ctrl-c` or (in another terminal) run

## Production build
A production build should define its own `docker-compose.yaml`, making use of the `Dockerfile` of the `backend` and `frontend` environments. It should also define a custom .env file, with safe passwords for the SQL database and the Python backend. Instead of mounting the entire backend and frontend directory and using the development servers, the backend should serve with gunicorn, and the frontend should use a build script to compile static html, css and JavaScript.

## Run tests

### Frontend tests

To run the frontend tests, run the following command:

```sh
docker compose run --rm client yarn test --watchAll=false

# or use the script
./scripts/test-frontend
```

#### Watch mode

To run the frontend tests in watch mode, which allows you to re-run tests when you change files, run the following command:

```sh
docker compose run --rm client yarn test

# or use the script
./scripts/test-frontend-watch
```

### Backend tests

To run the backend tests, run the following command:

```sh
docker-compose run --rm server bash -c "python manage.py test"

# or use the script
./scripts/test-backend
```

0 comments on commit bd1d838

Please sign in to comment.