Skip to content

Commit

Permalink
update readme with docker instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tnn4 committed May 8, 2023
1 parent dcc2725 commit c640869
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,20 @@ $ bin/poke-rs-api --port <your-port>

Manually:

Build image:
Build image:
- `docker build -t poke-rs-api -f Dockerfile-main .`

Run container from image:
- `docker run --name my_container_name -p 3001:3001 poke-rs-api`

Delete image:
- `docker rm my_container_name`

Or use the script - `./docker-build.sh`

- If you want to change the port in docker: change the line at `CMD` in the `Dockerfile-main` to something like:

`Dockerfile-main`

```dockerfile
CMD ["bin/poke-rs-api","--docker", "--port", "<your-port>"]
```
Expand Down Expand Up @@ -119,7 +121,7 @@ and will serve endpoints like `http://localhost:3000/pokeapi/pokemon/0`

---

## Build with docker container
## Docker reference
If you have Docker and have available memory and disk space, use the provided `Dockerfile` to do all the work for you.

[Important: Build the cache first](#populate-cache)
Expand Down Expand Up @@ -148,8 +150,6 @@ tnn4/poke-rs-api v0.1.0 ae5528709935 23 minutes ago
```




### Available Endpoints

These are the endpoints that the backend can serve. You can always extend the source to add more.
Expand Down

0 comments on commit c640869

Please sign in to comment.