Partido Server

This is the backend server application of the Partido platform written in Java with the Spring Framework.

Partido itself is a platform independent App for sharing group expenses.

How to contribute to the project

You can contribute in various ways - even if you're not a software developer. You can translate Partido to your language, report bugs, request features or code. Please check the contribution guidelines to start.

How to run the server for development and testing purposes

Go into the project root folder and run

mvn spring-boot:run

to start the spring application, or just press the IDE's run button.

The server will listen on Port 8080 per default (defined in ./src/main/resources/application.properties).

API

The server does not allow normal access via web browser, except for the following cases:

• verifying new user accounts
• resetting passwords after verifying mail addresses
• health checks

All other operations must be done with a REST client. Normally this would be the Partido Client App but for testing you can use any REST tool like Insomnia, Postman, etc.

OpenAPI Spec of the server is on the To Do List...

Database

The server needs an already existing PostgreSQL database.

If you want to run PostgreSQL with Docker, see the next sub-section.

The defaults defined in ./src/main/resources/application.properties are:

## Spring DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
spring.datasource.url=jdbc:postgresql://localhost:5433/partido
spring.datasource.username=postgres
spring.datasource.password=postgres

You can override these properties with custom start parameters.

Run PostgreSQL in a Docker container

To create a postgres container, you can go into the project root folder and run:

docker-compose -f ./docker/postgres.yml up -d

Mail sending on local machine

Per default, the server tries to send emails to localhost on Port 25 without any credentials. If you don't have a (fake) Mailserver installed, the console will output some specific errors, you can ignore. If you want to get those emails, you can use a tool like FakeSMTP.

How to prepare the server for production

Go into the project root folder and run

mvn clean package

A new partido-server-*.jar will be generated and placed in the target/ folder.

The resulting .jar file can now be run with additional settings like in the following script example where public api url, datasource settings and mail server options are customized (all options in the ./src/main/resources/application.properties file can be overwritten on startup):

#!/bin/sh
nohup java -jar /home/partido/partido-server-1.0.0.jar \
--partido.api_base=https://api.example.com/ \
--partido.remember_me_token_generation_key='someotherrandomtext' \
--server.port=8080 \
--server.address=127.0.0.1 \
--spring.datasource.username=username \
--spring.datasource.password=password \
--spring.datasource.url=jdbc:postgresql://localhost:5432/partidodb \
--spring.mail.host=mail.example.com \
--spring.mail.port=587 \
--spring.mail.username=no-reply@example.com \
--spring.mail.password=password \
--spring.mail.properties.mail.smtp.auth=true \
--spring.mail.properties.mail.smtp.starttls.enable=true