Gunmer / alfred-api

Alfred API

About

Getting Started

All commits in this project comply with the Conventional Commits specification.

Prerequisites

You must be had installed:

• JDK 17

Installation

1. Clone the repo

   git clone https://github.com/Gunmer/alfred-api.git

2. Build project

   ./gradlew build

Run

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'

Profiles

• local: To run in localhost with a h2 database in memory
• dev: Coming soon
• prod: Coming soon

Testing

This API has 3 types of tests, although by default all of them run.

./gradle test

Unit Test

./gradle test -Dtags='UnitTest'

Functional test

./gradle test -Dtags='FunctionalTest'

Architecture test

Coming soon