RTogether-api

Backend API for RTogether web application

Dependencies

Before starting, make sure you have the following dependencies installed:

• Maven
• Java 17
• Docker or Podman
• Docker Compose or Podman Compose

Configuration

1. Create a .env file in the root directory of the project based on the .env.example file.

cp .env.example .env

Running the Project

Using Docker

Make the build-and-run.sh script executable:

chmod +x build-and-run.sh

Execute the script to build and run the project:

./build-and-run.sh

Using Podman

Make the podman-build-and-run.sh script executable:

chmod +x podman-build-and-run.sh

Execute the script to build and run the project:

./podman-build-and-run.sh

Manual Execution

If you prefer not to use the scripts, follow these steps:

1. Export env variables

export $(cat .env | xargs)

2. Build the project using Maven:

mvn clean package -DskipTests

3. Build the Docker (or Podman) image:

docker-compose build
# or
podman-compose build

4. Start the containers:

docker-compose up -d
# or
podman-compose up -d

5. Execute the tests:

mvn test