aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 50615424a1601e0aad843be598523cd989ce52a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 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.
## 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.