This is the official FAForever API. Amongst others, the API offers the following functionality:
The application requires a database scheme in the right version. To create this database please checkout the project faf-stack, open a shell terminal (git bash on Windows) and run the script scripts/init-db.sh
. This will setup the database in the latest version and configure the users for you.
In order to run the application from source code:
FafApiApplication
Given the number of required configuration values, it's easiest to run the API using faf-stack:
docker-compose up -d faf-java-api
Due to potential issues with Hibernate, the application checks on startup if the flyway migration version matches the expected version and otherwise fails to boot.
faf-api.database.schema-version
(just an integer of the version)FAF_DB_VERSION
(git tag of the db release, usually prefixed with a v
)DATABASE_SCHEMA_VERSION
This project uses: