local deployment instructions

AMI-system · Nov 20, 2024 · 0f986aa · 0f986aa
1 parent 1c0e66b
commit 0f986aa
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
-# ami-dashboard
-dashboard for AMBER project
+# Ami Dashboard
+
+Dashboard for AMBER project currently hosted [here](https://ami-system.github.io/ami-dashboard/).
+
+## Running locally
+
+To view the dashboard on [http://localhost:8000](http://localhost:8000), run the following command in the root directory of the repository:
+
+```
+python -m http.server 8000
+```
+