1 files changed, 51 insertions, 0 deletions
diff --git a/app/README.md b/app/README.md
new file mode 100644
index 0000000..ad61a6b
--- /dev/null
+++ b/app/README.md
@@ -0,0 +1,51 @@
+How to run EnglishPal
+===========================
+
+
+
+Hui Lan <hui.lan@cantab.net>
+1 November 2019
+
+
+
+
+
+Run it on a local machine
+-------------------------
+
+python3 main.py
+
+
+
+
+
+
+Run it within Docker
+--------------------
+
+Assuming that docker has been installed...
+
+
+ssh to ubuntu@@118.25.96.118
+cd to /home/lanhui/englishpal
+
+# Stop service
+sudo service docker restart
+
+# Rebuild container. Run this after modifying the source code.
+sudo docker build -t englishpal .
+
+# Run the application
+sudo docker run -d -p 90:80 -v /home/lanhui/englishpal/app/static/frequency:/app/static/frequency -t englishpal  # for permanently saving data
+sudo docker run -d -p 90:80 -t englishpal # data will be lost after existing
+
+# Save space.  Run it after sudo docker run
+sudo docker system prune -a
+
+
+# Other commands
+sudo docker ps -a
+
+sudo docker logs image_name, where image name could be obtained from sudo docker ps.
+
+