aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Anshul Gupta <ansg191@anshulg.com> 2024-06-07 19:30:55 -0700
committerGravatar Anshul Gupta <ansg191@anshulg.com> 2024-06-07 19:31:16 -0700
commit027f5abf5256af7d7b6b563e25785c52d5033d4f (patch)
treed698debc15c68ad8350456991b3dce5f6720b77d
parent234e59c0e4cefb22492c3ebc07779781524f09ff (diff)
downloadCS172-Project-027f5abf5256af7d7b6b563e25785c52d5033d4f.tar.gz
CS172-Project-027f5abf5256af7d7b6b563e25785c52d5033d4f.tar.zst
CS172-Project-027f5abf5256af7d7b6b563e25785c52d5033d4f.zip
Add docker instructions
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77b0139..1944ab8 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,14 @@ With the dependencies installed, the server can be run by executing the followin
The script will check for the dependencies, compile the frontend, and start the server on port 5000.
+## Running via Docker
+
+To avoid installing dependencies, the server can be run via Docker using the following container `ghcr.io/ansg191/cs172-project:main`.
+To run via docker, simply run:
+```sh
+docker run -p 5000:5000 ghcr.io/ansg191/cs172-project:main
+```
+
## Manually Running
To manually run the server, run the following commands: