aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhongheng Liu <z.liu@outlook.com.gr>2024-05-25 23:09:39 +0300
committerZhongheng Liu <z.liu@outlook.com.gr>2024-05-25 23:09:39 +0300
commit4674503a2cfe978470b38ac20449298f3f1b1c59 (patch)
tree63e87236a427ba78505ecd7a41ec9eceddb6cf9e
parentf46ad1d65b6205e086ecdb61f5cd2ffabcd98b58 (diff)
downloadepq-api-main.tar.gz
epq-api-main.tar.bz2
epq-api-main.zip
chore: update README.mdHEADmain
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0ea15c8..5061542 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,15 @@
> 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
+### For devenv-enabled NixOS systems
+Having installed devenv from (devenv.sh)[https://devenv.sh], run:
+```devenv up``` to run app in foreground or ```devenv up -d``` to run in background.
+See more detailed devenv usage in the website.
+### Manual method for non-NixOS systems
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
+3. Test the web frontend by logging onto `localhost:8080` and test the functionality of the application.