From cfecd5e64b85d7c3e2d321ce9d89911179bd96c1 Mon Sep 17 00:00:00 2001 From: Sol <94075844+sjd210@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:36:32 +0000 Subject: [PATCH] Update README.md to include Docker deployment --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index de2620e..175d797 100644 --- a/README.md +++ b/README.md @@ -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 +```