Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AetherUnbound committed Dec 8, 2021
1 parent 7fef014 commit 100feb7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Licenses are looked up in the dataset and if a vehicle is found, that data is di

## Development

### If you just want to run the app
We use the [`just` command runner](https://github.com/casey/just), you'll need to install it before running any steps below.

Build the image with `docker build -t <tag> .`. Run it with `docker run -p 5000:5000 <tag>`.
### Build and run the app

Build the image with `just build` and run it using `just up`.
The server will be available at port `3030`.

### If you want to make changes

1. Install a python virtual environment: `python3 -m venv venv`
2. Activate the virtual environment: `source venv/bin/activate`
3. Install dependencies: `pip install -r requirements-dev.txt`
4. Install the pre-commit hook: `pre-commit install`
5. Run the app: `cd src; FLASK_DEBUG=1 flask run`
6. Make changes and contribute 🙌
The flask server will detect any changes made to the code and restart the application to pick up said changes.

To run the static checks (`just lint`), you will first need to [install `pre-commit`](https://pre-commit.com/).

0 comments on commit 100feb7

Please sign in to comment.