Budget

Pulls game information for Neptune's Pride and attempts to display it in a simple Web Interface with REST endpoints.

Currently only supports Triton games

Usage

via Github

1. Make sure you have a supported version of Java installed: java --version
2. Clone the repo: git clone https://github.com/Buried-In-Code/Neptunes-Dashboard
3. Build using: ./gradlew build
4. Run using: java -jar /app/build/libs/Neptunes-Dashboard-fatJar.jar

via Gradle

1. Make sure you have a supported version of Java installed: java --version
2. Clone the repo: git clone https://github.com/Buried-In-Code/Neptunes-Dashboard
3. Run using: ./gradlew build run

via Docker-Compose

1. Make sure you have Docker installed: docker --version
2. Make sure you have Docker-Compose installed: docker-compose --version
3. Create a docker-compose.yaml file, an example:

version: '3'

services:
  budget:
    image: 'ghcr.io/buried-in-code/neptunes-dashboard:latest'
    container_name: 'Neptunes Dashboard'
    environment:
      TZ: 'Pacific/Auckland'
    ports:
      - '25710:25710'
    volumes:
      - './config:/app/config'
      - './data:/app/data'

4. Run using: docker-compose up -d

Socials