This is a prototype of a Spring Boot based API application for Forged Alliance Forever.
In order to run the application from source code:
- Clone the repository
- Import the project into IntelliJ. For some reason, IntelliJ deletes launch configurations after import. Please revert such deleted files first (Version Control (Alt+F9) -> Local Changes)
- Configure your JDK 8 if you haven't already
- Make sure you have the IntelliJ Lombok plugin installed
- Set up a FAF database.
- Launch
FafApiApplication
Given the number of required configuration values, it's easiest to run the API using faf-stack
:
docker-compose up -d faf-api
- API documentation
- List event definitions
- List 5 maps with more than 8 players
- List UI mods, sorted by last updated ascending
- List all players
- List events of players
- List replays
This project uses:
- Java 8 as the programming language
- Spring Boot as a framework
- Hibernate ORM as ORM mapper
- Elide with RSQL filters to serve JSON-API conform data
- Gradle as a build automation tool
- Docker to deploy and run the application
- Swagger as an API documentation tool