Overworld-backend

Development

Getting started

Beginning of additions (that work)

Make sure you have the following installed:

• Java: JDK 1.17 or higher
• Maven: Maven 3.6.3
• Docker: Docker
• PostgreSQL: PostgreSQL

Run

Project build

To build the project, run:

mvn install

in the project folder. Then go to the target folder:

cd target

and run:

java -jar overworld-backend-0.0.1-SNAPSHOT.jar

to start the application.

Build with docker

To run your local changes as a docker container, with all necessary dependencies, build the Docker container with:

docker compose up --build

You can remove the containers with:

docker compose down

If you wish to run the backend with all minigames as dependencies use:

docker compose -f docker-compose-complete.yaml up --build

You can remove the containers with:

docker compose -f docker-compose-complete.yaml down

Run local with dependencies

To run your local build within your IDE, but also have the dependencies running in docker, follow the steps to build the project, then run the dependencies in docker with the following:

docker compose -f docker-compose-dev.yaml up 

You can remove the containers with:

docker compose -f docker-compose-dev.yaml down

If you wish to also start all minigames as dependencies use:

docker compose -f docker-compose-complete-dev.yaml up 

You can remove the containers with:

docker compose -f docker-compose-complete-dev.yaml down

End of additions

Testing database

to set up a database with docker for testing you can use

docker run -d -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres  --rm --name overworld-database postgres

To stop and remove it simply type

docker stop overworld-database