Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pagopa/pagopa-gpd-payments-pull
https://github.com/pagopa/pagopa-gpd-payments-pull
pagopa-gpd
Last synced: about 18 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/pagopa/pagopa-gpd-payments-pull
- Owner: pagopa
- Created: 2024-03-21T09:04:23.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-22T08:23:46.000Z (14 days ago)
- Last Synced: 2025-01-22T09:26:41.009Z (14 days ago)
- Topics: pagopa-gpd
- Language: Java
- Homepage:
- Size: 408 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# pagoPA GPD Payments Pull
[](https://sonarcloud.io/dashboard?id=pagopa_pagopa-gpd-payments-pull)
Expose APIs that will be used by IO to retrieve the list of the debtor positions.
---
## Summary 📖
- [Api Documentation 📖](#api-documentation-)
- [Technology Stack 📚](#technology-stack-)
- [Start Project Locally 🚀](#start-project-locally-)
* [Run locally with Docker](#run-locally-with-docker)
+ [Prerequisites](#prerequisites)
+ [Run docker container](#run-docker-container)
* [Running the application in dev mode](#running-the-application-in-dev-mode)
- [Develop Locally 💻](#develop-locally-)
* [Prerequisites](#prerequisites)
* [Testing 🧪](#testing-)
+ [Unit test](#unit-test)
+ [Integration test [WIP]](#integration-test-wip)
+ [Performance test [WIP]](#performance-test-wip)
- [Contributors 👥](#contributors-)
* [Maintainers](#maintainers)
---
## Api Documentation 📖
See
the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-gpd-payments-pull/main/openapi/openapi.json)
In local env typing following url on browser for ui interface:
```http://localhost:8080/q/swagger-ui```
or that for `yaml` version ```http://localhost:8080/q/openapi```
or that for `json` version ```http://localhost:8080/q/openapi?format=json```
---
## Technology Stack 📚
- Java 17 Runtime Environment GraalVM CE
- [Quarkus](https://quarkus.io/)
- quarkus-resteasy-reactive
- quarkus-smallrye-health
- quarkus-smallrye-openapi
- quarkus-resteasy-reactive-jackson
- quarkus-hibernate-reactive-panache
- quarkus-reactive-pg-client
- reactor-netty
- lombok (provided)
---
## Start Project Locally 🚀
### Running the application in dev mode
You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
```
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only
> at http://localhost:8080/q/dev/.
### Run locally with Docker
#### Prerequisites
- docker
#### Set environment variables
`docker build -t pagopa-gpd-payments-pull .`
`cp .env.example .env`
and replace in `.env` with correct values
#### Run docker container
then type :
`docker run -p 8080:8080 --env-file=./.env pagopa-gpd-payments-pull`
## Develop Locally 💻
### Prerequisites
- git
- maven (v3.9.3)
- jdk-17
### Testing 🧪
#### Unit test
Typing `mvn clean verify`
#### Integration test [WIP]
- Run the application
- Install dependencies: `yarn install`
- Run the test: `yarn test`
#### Performance test
- Run the application
- Run the test: `sh run_performance_test.sh local `
---
## Contributors 👥
Made with ❤️ by PagoPa S.p.A.
### Maintainers
See `CODEOWNERS` file