PayMyBuddy is a web application to easily send money to your friends!

Documentation

• REST API

Getting started

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

• Install Maven 3.6+
• Install Java 8+
• Install Docker and Docker Compose

Running App

Start the docker development environment:

./dev.sh docker up -d
./dev.sh db-seed  #(optional: feed the database with tests data)

Compile the server with maven and run it:

mvn package
cd server/target/
java -jar paymybuddy-server.jar

Then compile the client and run it:

cd client/
npm i
npm run build
npm run start

Testing

To run the tests, type:

mvn verify

Deployment

See DEPLOYMENT.md.

UML Diagrams

• Domain Class Diagram
• Database Implementation Diagram

Notes

This is a school project (for OpenClassrooms).

The goal is to create a java web application.