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

Updated README

Browse source
This commit is contained in:
Zhongheng Liu 2024-01-02 19:39:54 +02:00
commit 9585e3256b
No known key found for this signature in database
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,4 +1,12 @@
# EPQAPI # EPQAPI
## This is the Spring Boot Persistence API for my EPQ backend. > 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. > 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
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.