{"id":18425738,"url":"https://github.com/faforever/faf-moderator-client","last_synced_at":"2025-04-07T16:32:01.151Z","repository":{"id":26984211,"uuid":"110305246","full_name":"FAForever/faf-moderator-client","owner":"FAForever","description":"FAF Moderator Client","archived":false,"fork":false,"pushed_at":"2025-03-20T03:09:39.000Z","size":1218,"stargazers_count":4,"open_issues_count":13,"forks_count":11,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-03-22T21:23:57.032Z","etag":null,"topics":["faf","gradle","hacktoberfest","javafx","javafx-desktop-apps","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FAForever.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-11T00:24:48.000Z","updated_at":"2025-02-02T19:11:40.000Z","dependencies_parsed_at":"2023-01-14T05:44:45.717Z","dependency_job_id":"d93309ee-7cfc-4079-bca9-db3f36386319","html_url":"https://github.com/FAForever/faf-moderator-client","commit_stats":null,"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Ffaf-moderator-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Ffaf-moderator-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Ffaf-moderator-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Ffaf-moderator-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FAForever","download_url":"https://codeload.github.com/FAForever/faf-moderator-client/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247688018,"owners_count":20979581,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["faf","gradle","hacktoberfest","javafx","javafx-desktop-apps","spring-boot"],"created_at":"2024-11-06T05:05:22.629Z","updated_at":"2025-04-07T16:31:59.772Z","avatar_url":"https://github.com/FAForever.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FAF Moderator Client [![Build](https://github.com/FAForever/faf-moderator-client/actions/workflows/build.yml/badge.svg)](https://github.com/FAForever/faf-moderator-client/actions/workflows/build.yml)\nThis application enables faforever.com moderators to perform administrative actions. This involves:\n- managing of users, user groups and permissions\n- uploading and assigning avatars\n- managing matchmaker map pools\n- map \u0026 mod vault\n- checking recent activities\n- editing runtime translations\n\n# How to use / run it\n- Make sure you have Java 21 or higher installed (JRE or JDK does not matter). Adoptium offers free installation\n  packages [here](https://adoptium.net/?variant=openjdk21) (other Java flavours like Oracle should also work)\n- Download the right client version for your operating system from the release page\n- Unzip it\n- Go to the bin folder and run the .bat script (Windows) or the .sh script (Linux)\n- Login with your FAF credentials\n\n# Setting up your environment\n\n## Recommended software\n- We recommend [JetBrains IntelliJ](https://www.jetbrains.com/idea) as IDE. The community edition is free and open source.\n- For editing the user interface, we strongly recommend [Scene Builder](https://gluonhq.com/products/scene-builder)\n- For a simple setup and testing of the dependencies you should use [Docker](https://www.docker.org) and [Docker Compose](https://github.com/docker/compose/releases)\n\n## Boot the dependencies\n- Checkout the [FAF Stack](https://github.com/FAForever/faf-stack) and initialize the database (`scripts/init-db.sh`).\n  Afterwards boot the api via `docker-compose up -d faf-java-api`.\n- Get some [test data](https://github.com/FAForever/db/blob/develop/test-data.sql) and insert it into the MySQL db (\n  user: root \u0026 password: banana). A tool like HeidiSQL can help you with this. This also adds a moderator account with\n  username: test \u0026 password: test_password\n\n## Run from source\n\n1. Clone the project with git\n1. Import the project into IntelliJ as \"Gradle Project\"\n1. Make sure you have the IntelliJ [Lombok plugin](https://plugins.jetbrains.com/idea/plugin/6317-lombok-plugin) installed\n1. Make sure you have `Enable annotation processing` enabled in the settings\n1. Add the dev profile as command line options (\"VM options\" in IntelliJ) using `-Dspring.profiles.active=dev`\n1. Add your platform as parameter for all Gradle processes e.g. `-PjavafxPlatform=win` for Windows.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaforever%2Ffaf-moderator-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaforever%2Ffaf-moderator-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaforever%2Ffaf-moderator-client/lists"}