https://github.com/gunmer/alfred-api
https://github.com/gunmer/alfred-api
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gunmer/alfred-api
- Owner: Gunmer
- Created: 2022-07-30T00:48:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-16T20:51:28.000Z (almost 4 years ago)
- Last Synced: 2025-06-10T12:11:51.880Z (about 1 year ago)
- Language: Kotlin
- Size: 143 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Alfred API
## About
## Getting Started
> All commits in this project comply with the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
### Prerequisites
You must be had installed:
- JDK 17
### Installation
1. Clone the repo
```sh
git clone https://github.com/Gunmer/alfred-api.git
```
2. Build project
```sh
./gradlew build
```
### Run
To run the project should execute
```sh
./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:
```sh
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.
```sh
./gradle test
```
#### Unit Test
```sh
./gradle test -Dtags='UnitTest'
```
#### Functional test
```sh
./gradle test -Dtags='FunctionalTest'
```
#### Architecture test
Coming soon