Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
digicosmos86 committed Jul 8, 2024
1 parent 0da115d commit f53ef36
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ written in Rust with high performances. Since `rye` is compatible with PEP 621
`pyproject.toml`, other packaging management tools such as `hatch` or `pdm` should also
work. It, however, won't work with `poetry`.

We also use `docker` to build the container image that you can test on your local
machine. If you have not already installed docker, please click
[here](https://docs.docker.com/engine/install/) to install it. Once you have installed
docker, make sure that `docker -v` runs successfully on your command line.

### Step 1: Create a repo from this template Clone this repo

First, please create a new repo using this template and use the following command to
Expand Down Expand Up @@ -66,7 +71,7 @@ fastapi dev ./src/fastapi_image/main.py
Test scripts are located in the `tests` directory. To run tests, use

```sh
rye run tests
rye run test
```

**Note**: Simply calling the `pytest` cli or `rye test` will result in errors because
Expand All @@ -83,4 +88,4 @@ rye run build
rye run container
```

The container will be available at https://127.0.0.1:8080/
The container will be available at http://127.0.0.1:8080/

0 comments on commit f53ef36

Please sign in to comment.