steven/epq-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update README.md

Browse source
This commit is contained in:
Zhongheng Liu 2024-05-25 23:09:39 +03:00
commit 4674503a2c
No known key found for this signature in database
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -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. > 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. > It should not be considered a commercial-grade application.
## Deploying this IRC 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: 1. Ensure that `mariadb` is deployed and running. In Linux environments this can be done with `systemd` through the following command:
```systemctl start mariadb``` ```systemctl start mariadb```
or if you wish to have `mariadb` start each time on startup, use: or if you wish to have `mariadb` start each time on startup, use:
```systemctl enable mariadb``` ```systemctl enable mariadb```
2. Run the packaged application in JAR archive format with the following command: 2. Run the packaged application in JAR archive format with the following command:
```java -jar <PATH_TO_JAR> <JVM_PARAMETERS>``` ```java -jar <PATH_TO_JAR> <JVM_PARAMETERS>```
3. Test the web frontend by logging onto `localhost:8080` and test the functionality of the application. 3. Test the web frontend by logging onto `localhost:8080` and test the functionality of the application.