Skip to content

Commit

Permalink
docs: How to test and lint
Browse files Browse the repository at this point in the history
  • Loading branch information
mauricioabreu committed Apr 11, 2024
1 parent 0b83e5e commit 71a3eee
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ The platform is built using the following technologies:
* [gpac](https://gpac.io/) for the encoding, transcoding, and packaging
* [asynq](https://github.com/hibiken/asynq) for distributing tasks to workers

## Running
## Development

### Running

All tasks are managed by a Justfile. You can see all the available tasks by running:

Expand All @@ -49,6 +51,20 @@ To run the platform, you need to have Docker and docker compose installed. Then,
docker compose up
```

### Code Quality

To run the test suite:

```sh
just test
```

To run code linting:

```sh
just lint
```

## Contributing

Feel free to contribute to this project by opening issues or pull requests.

0 comments on commit 71a3eee

Please sign in to comment.