Predictr

A football prediction game.
Data for UEFA Euro 2024 included.

Requirements

• Install jdk8, maven, ruby, nodejs and npm using your OS package manager.

• Install the required node modules globally:

  npm install -g bower grunt-cli
  

• For compiling SCSS to CSS, the RubyGem sass is also needed:

  gem install sass
  

Development

• Install the project dependencies:

  npm install
  bower install
  

• Run with development profile:

  mvn spring-boot:run
  

• Open up a new terminal and launch the node web server:

  grunt serve
  

• Open http://localhost:3000 in a web browser.

Production

To build the Docker image, be sure that local docker daemon is installed and running to build the image. Your shell user also needs to be a member of the docker group.

Login to registry (only needed once)

  docker login docker.io

Build the image

  mvn dockerfile:build
  mvn dockerfile:tag@tag-version

Push to docker registry

  mvn dockerfile:push@push-latest
  mvn dockerfile:push@push-version

• For database tasks, i recommend using a database manipulating tool like Adminer or phpMyAdmin.

• Create a MySQL database and grant access rights to a user.

• Run with production profile (replace credentials):

  java -jar target/predictr*.jar \
    --spring.profiles.active=production \
    --spring.datasource.url=jdbc:mysql://dbhost/dbname \
    --spring.datasource.username=dbuser \
    --spring.datasource.password=dbpassword \
    --spring.mail.host=mailserver \
    --spring.mail.username=mailuser \
    --spring.mail.password=mailpassword
  

• Open http://localhost:8080/#/register in a web browser and register a new user.

• Upgrade the created user to an admin setting the field role to ROLE_ADMIN.

• You can now log in using the admin user.

Credits

Logo image Euro 2024 by Tim Reckmann