Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pagopa/pagopa-mbd-service

๐Ÿ“ @e.Bollo 2.0
https://github.com/pagopa/pagopa-mbd-service

pagopa-gpd pagopa-mbd

Last synced: about 18 hours ago
JSON representation

๐Ÿ“ @e.Bollo 2.0

Awesome Lists containing this project

README

        

# pagoPA Marca da Bollo Digitale Service

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=pagopa_pagopa-mbd-service&metric=alert_status)](https://sonarcloud.io/dashboard?id=pagopa_pagopa-mbd-service)

Expose APIs that will be used by end user to pay a digital "marca da bollo"

---

## 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-mbd-service/main/openapi/openapi.json)

---

## Technology Stack ๐Ÿ“š

- Java 17
- Spring Boot
- Spring Web
- Hibernate
- JPA
- OpenFeign
- Lombok

---

## Start Project Locally ๐Ÿš€

#### Prerequisites

- docker

#### Set environment variables

`docker build -t pagopa-mbd-service .`

`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-mbd-service`

## Develop Locally ๐Ÿ’ป

### Prerequisites

- git
- maven
- 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 [WIP]

---

## Contributors ๐Ÿ‘ฅ

Made with โค๏ธ by PagoPa S.p.A.

### Maintainers

See `CODEOWNERS` file