Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pagopa/pagopa-gpd-upload
GPD micro-service that provides Bulk APIs for managing payment positions via file upload
https://github.com/pagopa/pagopa-gpd-upload
pagopa-gpd pagopa-gpd-upload
Last synced: about 18 hours ago
JSON representation
GPD micro-service that provides Bulk APIs for managing payment positions via file upload
- Host: GitHub
- URL: https://github.com/pagopa/pagopa-gpd-upload
- Owner: pagopa
- Created: 2023-11-28T08:26:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T13:12:49.000Z (2 months ago)
- Last Synced: 2024-12-10T17:12:42.587Z (about 2 months ago)
- Topics: pagopa-gpd, pagopa-gpd-upload
- Language: Java
- Homepage:
- Size: 758 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
## GPD Massive Upload µ-service
[](https://sonarcloud.io/dashboard?id=pagopa_pagopa-gpd-upload)
[](https://github.com/pagopa/pagopa-gpd-upload/actions/workflows/integration_test.yml)
This microservice has the responsibility of handling the upload of the files holding debt positions.
It allows the creditor institutions to:
- CRUD operations on Debt Positions through zip file Upload
- Get Debt Positions massive Upload status
- Get Debt Positions massive Upload report
---
## Api Documentation 📖
See the external [OpenApi 3 here.](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-gpd-upload/main/openapi/openapi.json)
See the internal [OpenApi 3 here.](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-gpd-upload/main/openapi/openapi-support-internal.json)
---
## Technology Stack
- Java 17
- Micronaut
- Azure Storage Blob
---
## Start Project Locally 🚀
### Prerequisites
- docker
### Run docker container
1. From `./docker` directory
```
sh ./run_docker.sh local
```
2. From `root` directory
```
docker build -t .
docker run -p 8080:8080 --env-file
```
---
## Develop Locally 💻
### Prerequisites
- git
- maven
- jdk-17
### Run the project
```
cp .env.sample .env
```
After setting all required environment variables
```
set -o allexport
source .env
set +o allexport
```
Start the micronaut application with this command:
`mvn mn:run`
Start without hot reload
`mn:run -Dmn.watch=false`
### Rule of thumb
Prevent more than 1 file in with macOS
`zip -d filename.zip __MACOSX/\*`
`zip -d filename.zip \*/.DS_Store`
`zip file.zip uncompressed`
### Micronaut Profiles
- **local**: to develop locally.
- _default (no profile set)_: The application gets the properties from the environment (for Azure).
### Testing 🧪
#### Unit testing
To run the **Junit** tests:
`mvn clean verify`
#### Integration testing
From `./integration-test/src`
1. `yarn install`
2. `yarn test`
#### Performance testing
install [k6](https://k6.io/) and then from `./performance-test/src`
1. `k6 run --env VARS=local.environment.json --env TEST_TYPE=./test-types/load.json main_scenario.js`
---
## Contributors 👥
Made with ❤️ by PagoPa S.p.A.
### Mainteiners
See `CODEOWNERS` file