Skip to content

IPHUN1989/bytebattlers

Repository files navigation

Project Logo

GitHub repo size GitHub language count Static Badge GitHub contributors GitHub commit activity (branch) GitHub commit activity (branch) GitHub last commit (branch) GitHub closed issues GitHub issues GitHub pull requests

Information about the migration of the project

The original project has been cloned with permission to here and its development continues here from 22-05-2024. You can find the original repo here: https://github.com/CodecoolGlobal/el-proyecte-grande-sprint-1-java-szplkflrn

ByteBattlers

A full stack CRUD web application with the following technologies:

  • drawing React
  • drawing JavaScript
  • drawing Spring
  • drawing Java
  • drawing 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

Usage

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

Running it with Docker

# Navigate to the local folder
docker-compose up
  • Visit the dockerized website on localhost:3456

Local build

Prerequisites

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

Database

With a filled up 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

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

See also

Checkout the documentation of our project

About

A BoardgameGeek inspired web application

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published