Unofficial API for the game mixmaster FR.
wikipedia link

The database schema is available in the mixmaster-data repository.

You can also use Hibernate to initialise the database schema on API startup.

spring:
  jpa:
    hibernate:
      ddl-auto: update

All the configuration of the application is present in ./app/src/main/resources/application.yml. If you need to edit some of the configuration you can do it in the application-local.yml yml file.

By doing so you can override the database connection or add some debugging config lines

# Local database config
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/mixmaster?serverTimezone=UTC
    username: root
    password: root
  # Show SQL request executed by JPA
  jpa:
    show-sql: true

# Increase debug logging level
logging:
  level:
    org:
      hibernate:
        SQL: DEBUG
        type: trace

# Run the application
mvn spring-boot:run

# Execute the tests
mvn test

# Build the application
mvn clean install

# Or if you don't want the test to execute while building the jar
mvn clean install -DskipTests

To build the docker image and then launch it we use the following commands

docker build -t mixmaster-app/mixapi:latest .
docker run -p 0.0.0.0:3000:3000/tcp mixmaster-app/mixapi:latest

you can also use existing docker images available on GitHub container registry (https://ghcr.io): mixapi docker registry

To setup your own dev environment you'll need:

• Java SDK 21.x (Download java)
• Maven 3.x (Download maven)

If you want to set up MySQL locally you can use the ./docker/dev/docker-compose.yml file to do so (On Windows this will require you to install docker-desktop).

For any configuration changes required you can create an ./app/src/main/resources/application-local.yml file which will override the main application.yml configs (cf. How to ?).