README.md

Spontaneous Payments

PagoPA service for citizen/corporate spontaneous payments

• Spontaneous Payments
  • Api Documentation 📖
  • Technology Stack
  • Start Project Locally 🚀
    • Prerequisites
    • Run docker container
  • Develop Locally 💻
    • Run
    • Prerequisites
    • Run the project
    • Configure Cosmos emulator
    • Testing 🧪
      • Unit testing
      • Integration testing
      • Load testing
  • Contributors 👥
    • Mainteiners

---

Api Documentation 📖

Spring application exposes API to manage the Spontaneous Payments.

See the OpenApi 3 here.

In local env typing following url on browser for ui interface:

http://localhost:8080/swagger-ui/index.html

or that for yaml version http://localhost:8080/v3/api-docs/

---

Technology Stack

• Java 11
• Spring Boot
• Spring Web
• Hibernate
• JPA
• Spring cosmos api

---

Start Project Locally 🚀

Prerequisites

• docker
• Cosmos emulator

Run docker container

Under main project folder typing : docker-compose up --build

NOTE : before that compile gpd service with mvn clean package command

If all right, eventually you'll see something like that:

...
...

---

Develop Locally 💻

Run

mvn spring-boot:run -Dspring-boot.run.profiles=local

Prerequisites

• git
• maven
• jdk-11
• docker
• cosmosdb emulator

Run the project

The easiest way to develop locally is start only db container and run spring-boot application.

...

Configure Cosmos emulator

Launch the script in utilities folder:

To start CosmosDB

sh cosmos_start.sh <port> <java_home>

To init db/containers

python cosmos_init_db.py

NOTE : install pip install python-dotenv && pip install azure-cosmos and copy env file cp .env.exmaple .env

Testing 🧪

Unit testing

Typing mvn clean verify, if all right you'll see following stuffs

Integration testing

Todo

Load testing

Todo

✋ Manual testing

To emulate a paDemandPaymentNotice under utilities folder typing :

sh paDemandPaymentNotice.sh

Contributors 👥

Made with ❤️ from PagoPa S.p.A.

Mainteiners

See CODEOWNERS file