All commits in this project comply with the Conventional Commits specification.
You must be had installed:
- JDK 17
- Clone the repo
git clone https://github.com/Gunmer/alfred-api.git
- Build project
./gradlew build
To run the project should execute
./gradlew bootRun --args='--spring.profiles.active=local'
These command startup the API in the port 8080
and with the context-path: /alfred-api
. To ensure that API has been raised, we can call the health endpoint:
curl --request GET --url 'http://localhost:8080/alfred-api/actuator/health'
- local: To run in localhost with a h2 database in memory
- dev: Coming soon
- prod: Coming soon
This API has 3 types of tests, although by default all of them run.
./gradle test
./gradle test -Dtags='UnitTest'
./gradle test -Dtags='FunctionalTest'
Coming soon