aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhongheng Liu <z.liu@outlook.com.gr>2024-01-02 19:39:54 +0200
committerZhongheng Liu <z.liu@outlook.com.gr>2024-01-02 19:39:54 +0200
commit9585e3256b85cfa7c1e0355b58b38e79fb356bde (patch)
tree88bc9fc78497e019db610d2edb01f44dd5fc4426
parenta239346e81232414e4e57dc3d7fe49ebe31479c1 (diff)
downloadepq-api-9585e3256b85cfa7c1e0355b58b38e79fb356bde.tar.gz
epq-api-9585e3256b85cfa7c1e0355b58b38e79fb356bde.tar.bz2
epq-api-9585e3256b85cfa7c1e0355b58b38e79fb356bde.zip
Updated README
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index f8610a3..0ea15c8 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,12 @@
# EPQAPI
-## This is the Spring Boot Persistence API for my EPQ backend.
-This project is intended for use and presentation in (stvnliu)[https://github.com/stvnliu]'s A Level Edexcel Level 3 Extended Project Qualification as an Artifact.
-It should not be considered a commercial-grade application. \ No newline at end of file
+> This is the Spring Boot Persistence API for my EPQ backend.
+> This project is intended for use and presentation in (stvnliu)[https://github.com/stvnliu]'s A Level Edexcel Level 3 Extended Project Qualification as an Artifact.
+> It should not be considered a commercial-grade application.
+## Deploying this IRC application
+1. Ensure that `mariadb` is deployed and running. In Linux environments this can be done with `systemd` through the following command:
+```systemctl start mariadb```
+or if you wish to have `mariadb` start each time on startup, use:
+```systemctl enable mariadb```
+2. Run the packaged application in JAR archive format with the following command:
+```java -jar <PATH_TO_JAR> <JVM_PARAMETERS>```
+3. Test the web frontend by logging onto `localhost:8080` and test the functionality of the application. \ No newline at end of file