andrew
/
Gymboard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated readme.

This commit is contained in:
Andrew Lalis 2023-01-24 19:56:44 +01:00
parent 5cec0c79fb
commit 309a6fca5a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gymboard-api/README.md
View File

@ -1,3 +1,7 @@
# Gymboard API
An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint
An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint for all data processing, and is generally the first point-of-contact for the web app or other services that consume Gymboard data.
## Development
To ease development, `nl.andrewlalis.gymboard_api.model.SampleDataLoader` will run on startup and populate the database with some sample entities. You can regenerate this data by manually deleting the database, and deleting the `.sample_data` marker file that's generated in the project directory.