Information about the project migration

**This project has been cloned with permission and its development continues on https://github.com/IPHUN1989/bytebattlers from 22-05-2024.

ByteBattlers

A full stack CRUD web application with the following technologies:

• React
• JavaScript
• Spring
• Java
• PostgreSQL

Background

A BoardgameGeek inspired web application where users can:

• Search for board games
• Register themselves securely
• Add a board game to their virtual collection
• Rate/review any chosen board game

Prerequisites

• Maven 3.6.3
• Node 19.8.1
• Java 17.0.7
• NPM 9.5.1
• PostgreSQL 12.16
• Git 2.30.2

Usage

• Rename the teamplate_env file in the ${local_folder_of_cloned_project} to .env and fill out the requested variables

Database

With a dummy database: Create an empty database and run the query in the db/import.sql to initialize a dummy database with already existing data

With an empty database: Create an empty database and run the query in the backend/src/main/resources/db/migration/init-schema.sql to initialize a database with only the schema

Local build

Frontend

• Run the following command

# Run it in the main folder.
# Important to include the dot at the beggining of the command
. frontend.sh

Backend

• Run the following command

# Run it in the main folder in a new terminal
# Important to include the dot at the beggining of the command
. backend.sh

• After succesful build you can visit the website on localhost:4173

Running with Docker

# Navigate to the local folder
docker-compose up

• Visit the dockerized website on localhost:3456

See also

Checkout our WIKI page