Skip to content

Xpymb/freaks_aa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

190 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Freaks ArcheAge Guild CRM

Freaks AA is a CRM system designed to manage a guild in the MMORPG ArcheAge.
It’s built using a modular microservices architecture powered by .NET 9, Keycloak, PostgreSQL, Redis, RabbitMQ, and MinIO.

The platform allows guild administrators to organize raids, manage users and their roles, track activity, and integrate with external services like Discord.


🚀 Getting Started

To run the project locally using Docker Compose:

1. Clone the repository

git clone https://github.com/Xpymb/freaks_aa.git
cd freaks_aa

2. Prepare environment file

The project uses a .env file stored in the root of the docker/ folder. To initialize it:

cd docker
./setup-env.sh        # for Linux/macOS
setup-env.cmd         # for Windows

This script will:

  • Copy .env.local to .env
  • Prompt you to enter your KEYCLOAK_ADMIN_CLIENT_SECRET

3. Run services

There are convenience scripts for starting the environment:

  • Run full backend:
./run_docker-compose-local-back.sh    # for Linux/macOS
run_docker-compose-local-back.cmd     # for Windows
  • Run databases only:
./run_docker-compose-local-db.sh     # for Linux/macOS
run_docker-compose-local-db.cmd      # for Windows

📦 Dependencies

  • .NET 10 SDK
  • Docker + Docker Compose
  • Next.js (for frontend development)
  • Keycloak (runs via docker)
  • PostgreSQL, Redis, RabbitMQ, MinIO (included in docker-compose)

🔐 Authentication

The system uses Keycloak as the identity provider. After starting the system, Keycloak will be available at:

https://auth.freaks-aa.ru/

The swagger-ui clients are preconfigured with OAuth2 support in Swagger using Authorization Code flow.


⚒️ Development Notes

  • All service-specific environment and secrets are configured via .env
  • Local services use ports like 5010, 5020 etc. (per microservice)
  • Each microservice has its own API + NSwag documentation
  • Realm management and user roles are synced using Keycloak Admin API

📄 License

This project is under active development and licensed under MIT.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors