{"id":26109618,"url":"https://github.com/alezrik/game_services_umbrella","last_synced_at":"2025-10-12T21:52:50.366Z","repository":{"id":185224670,"uuid":"154597062","full_name":"Alezrik/game_services_umbrella","owner":"Alezrik","description":"A group of game services for elixir","archived":false,"fork":false,"pushed_at":"2018-12-11T07:40:54.000Z","size":314,"stargazers_count":5,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-09T23:12:35.845Z","etag":null,"topics":["elixir","game-service"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","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/Alezrik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2018-10-25T02:17:49.000Z","updated_at":"2024-06-26T15:11:26.000Z","dependencies_parsed_at":"2023-08-01T06:04:55.734Z","dependency_job_id":null,"html_url":"https://github.com/Alezrik/game_services_umbrella","commit_stats":null,"previous_names":["alezrik/game_services_umbrella"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Alezrik/game_services_umbrella","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alezrik%2Fgame_services_umbrella","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alezrik%2Fgame_services_umbrella/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alezrik%2Fgame_services_umbrella/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alezrik%2Fgame_services_umbrella/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Alezrik","download_url":"https://codeload.github.com/Alezrik/game_services_umbrella/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alezrik%2Fgame_services_umbrella/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013127,"owners_count":26085232,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["elixir","game-service"],"created_at":"2025-03-09T23:12:37.502Z","updated_at":"2025-10-12T21:52:50.342Z","avatar_url":"https://github.com/Alezrik.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CircleCI](https://circleci.com/gh/Alezrik/game_services_umbrella.svg?style=svg)](https://circleci.com/gh/Alezrik/game_services_umbrella)\n\n[![Coverage Status](https://coveralls.io/repos/github/Alezrik/game_services_umbrella/badge.svg?branch=master)](https://coveralls.io/github/Alezrik/game_services_umbrella?branch=master)\n\n# GameServicesUmbrella\n\nA collection of Services (better project name pending) to manage Multi Player Games.  Services will enable games to create a persistent multi player world.  Unreal Engine 4 will be used as the Game Client / Game Server(s) in a Multi Player RPG.\n\n## Getting Started\n\nSetting Up your Machine for Development / Test and Local Deployment\n\n## Documentation\n\nGenerate Documentation\n\n```bash\nmix doc \u0026\u0026 open doc/index.html\n```\n\n### Game Clients\n* Unreal Engine 4 - https://github.com/Alezrik/game_services_client-UE4\n\n### Installing / Local Deployment Game Services\n\nInstall [Docker](http://www.docker.io/) - Docker containers for local deployment build/release\n\nInstall [Minikube](https://github.com/kubernetes/minikube) - local Kubernetes - local deployment environment\n\nInstall [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - Kubernetes cli\n\nClone project\n\n```bash\ngit clone https://github.com/Alezrik/game_services_umbrella.git\n```\n\nInstall NPM packages\n\n```bash\ncd apps/game_services_web/assets\nnpm install\n```\n\nStartup minikube\n\n```bash\nmix kubernetes start_minikube\n```\n\nVerify Minikube services are up and running\n\n```bash\nmix kubernetes status\n```\n\nSwitch to Minikube docker service\n\n```bash\neval $(minikube docker-env)\n```\n\nNOTE Windows requires you to copy and paste the result of\n\n```windows\nE:\\game_services_umbrella\u003eminikube docker-env\nSET DOCKER_TLS_VERIFY=1\nSET DOCKER_HOST=tcp://192.168.99.100:2376\nSET DOCKER_CERT_PATH=C:\\Users\\ex_ra\\.minikube\\certs\nSET DOCKER_API_VERSION=1.35\nREM Run this command to configure your shell:\nREM @FOR /f \"tokens=*\" %i IN ('minikube docker-env') DO @%i\n```\n\nBuild Services Umbrella\n\n```bash\nmix docker build_umbrella\n```\n\nCreate Release\n\n```bash\nmix docker build_release\n```\n\nCreate Service User for Kubernetes\n\n```bash\nmix kubernetes create_auth_user\n```\n\nCreate Secrets for Services\n\n```bash\nmix kubernetes create_secrets\n```\n\nCreate a Headless Service for Internal Cluster\n\n```bash\nmix kubernetes create_headless\n```\n\nCreate an External Service for external http access\n\n```bash\nmix kubernetes create_service\n```\n\nCreate GameServicesUmbrella cluster\n\n```bash\nmix kubernetes deploy\n```\n\nVerify Cluster / Kubernetes Deployment\n\n```bash\nminikube dashboard\n```\n\n\n## Running in Development Environment\n\nNOTE: When running in development locally you will see some unintended messages from swarm (Issue)[https://github.com/Alezrik/game_services_umbrella/issues/15]\n\n```bash\nmix phx.server\n```\n\n## Executing Unit tests\n\nNOTE: When running unit tests locally you will see some unintended messages from swarm (Issue)[https://github.com/Alezrik/game_services_umbrella/issues/15]\n\n```bash\nmix test\n```\n\n## Elixir OTP Apps\n* [authentication](apps/authentication/README.md) - Authentication Service\n* [cluster_manager](apps/cluster_manager/README.md) - Cluster Manager Service\n* [game_services](apps/game_services/README.md) - Database Services\n* [game_services_web](apps/game_services_web/README.md) - [Pheonixframework](http://www.phoenixframework.org) - HTTP Frontend Service\n* [mix_docker](apps/mix_docker/README.md) - mix tasks for interacting with docker\n* [mix_kubernetes](apps/mix_kubernetes/README.md) - mix tasks for interacting with kubernetes/minikube\n* [user_manager](apps/user_manager/README.md) - services for managing user accounts\n\n## Changelog\n\nProject [Changelog](CHANGELOG.md)\n\n## Helpfuck Docker / Kubernetes Commands\n\nReset Docker to Normal Docker Service\n\n```bash\neval $(docker-machine env -u)\n```\n\nConnect to a Running Pod\n\n```bash\nkubectl get pods\nkubectl exec -it POD_NAME -c SERVICENAME -- /bin/bash\n./bin/SERVICENAME remote_console\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falezrik%2Fgame_services_umbrella","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falezrik%2Fgame_services_umbrella","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falezrik%2Fgame_services_umbrella/lists"}