Skip to content

Commit

Permalink
Update README.md to include Docker deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
sjd210 authored Dec 20, 2024
1 parent 4529f69 commit cfecd5e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,15 @@ Updated javascript version of the [old chemistry checker](https://github.com/isa
Use `yarn dev` or `yarn start` to run the server locally on the port defined in `.env`.

The chemistry checker is available on `/chemistry` and the nuclear checker is available on `/nuclear`. Both have a parser on `./parse` and a checker on `./check`.

# Docker deployment

1. Ensure that [Docker](https://www.docker.com/) is installed
2. To build, run:
```
docker build -t ghcr.io/isaacphysics/chemistry-checker-js:latest --pull .
```
3. To deploy to the GitHub Container Registry, run:
```
docker push ghcr.io/isaacphysics/chemistry-checker-js:latest
```

0 comments on commit cfecd5e

Please sign in to comment.