### Hello and welcome...

...to our brand new public API frontend website! Game segments that are exposed out here are:

- `Statistics` - near-live in-game statistics (refreshes every 2.5 minutes)
- `Auctions` - running card auctions from in-game Auction House (refreshes every 10 minutes)
- `Leaderboards` - in-game ranking/leaderboards tables (refreshes every 24 hours)
- `Documentation` - available Swagger/OpenAPI documentation for exposed services and their consumption

### About

This is an example of a `Web User Interface` for public `Application Programming Interfaces` of Skylords Reborn servers available for everyone to consume.

User interface applications are open-sourced on GitHub. The repository also contains complete instructions/documentation on how to consume the API yourselves, if you were to decide to create your own frontend applications. But, you have to be somewhat profficient in web development to understand and begin doing stuff on your own.

### Source

Source code can be found [in this repository on our GitLab](https://gitlab.com/skylords-reborn/Skylords-Reborn-API-Hub-Frontend).

The source code also includes a `Dockerfile`, for image building and container running with Docker.

`Issues` tab is to be used freely for any and all suggestions and bug reports.

`Pull Requests` that improve and extend the existing UIs are more than welcome. After manual review, they might get merged into the master branch and appear as a part of the next website update.

### Additional

There are not much instructions included, besides those on how to consume the API in the available `Swagger` / `OpenAPI` documentation, so you'll need some experience in working with mentioned tools/techonologies to be able to even understand what's going on.

Frontend application was made with `React` and `TypeScript`, using `AntDesign` as a UI framework.
Backend application was made with `Nest.js`.
Backend and frontend URLs can be found in respective `.env` files.

The backend is caching data periodically, so you're actually querying the in-memory data, and not the database directly, which does not have any kind of impact on the game servers and database performance itself.

Have fun!