{"id":26459975,"url":"https://github.com/fvergaracl/game","last_synced_at":"2025-08-21T12:41:35.031Z","repository":{"id":207582561,"uuid":"719603753","full_name":"fvergaracl/GAME","owner":"fvergaracl","description":"GAME (Goals And Motivation Engine) - Gamification framework","archived":false,"fork":false,"pushed_at":"2025-06-09T09:19:55.000Z","size":59031,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-09T09:20:01.450Z","etag":null,"topics":["api","api-rest","gamification","gamification-engine","gamification-framework"],"latest_commit_sha":null,"homepage":"https://fvergaracl.github.io/GAME/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fvergaracl.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.cz.toml","contributing":"CONTRIBUTING.md","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,"zenodo":null}},"created_at":"2023-11-16T14:16:29.000Z","updated_at":"2025-06-09T09:19:59.000Z","dependencies_parsed_at":"2023-11-20T10:27:07.888Z","dependency_job_id":"1648d083-2660-4efe-8ded-419244554d16","html_url":"https://github.com/fvergaracl/GAME","commit_stats":null,"previous_names":["fvergaracl/game"],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/fvergaracl/GAME","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvergaracl%2FGAME","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvergaracl%2FGAME/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvergaracl%2FGAME/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvergaracl%2FGAME/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fvergaracl","download_url":"https://codeload.github.com/fvergaracl/GAME/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvergaracl%2FGAME/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260059138,"owners_count":22953049,"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":["api","api-rest","gamification","gamification-engine","gamification-framework"],"created_at":"2025-03-19T02:12:12.133Z","updated_at":"2025-06-15T22:07:37.948Z","avatar_url":"https://github.com/fvergaracl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GAME (Goals And Motivation Engine) 🎮\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://codecov.io/gh/fvergaracl/GAME/branch/main/graph/badge.svg?token=R0MGAOMUBU\" alt=\"codecov\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/License-Apache_2.0-blue.svg\" alt=\"License Apache 2.0\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/fvergaracl/GAME\" alt=\"GitHub Repo stars\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/v/tag/fvergaracl/game?color=green\" alt=\"Last TAG\"\u003e\n\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"GAME_logo.png\" alt=\"GAME Logo\"\u003e\n\u003c/p\u003e\n\n## Welcome to GAME! 🏆\n\n**GAME** (Goals And Motivation Engine) is an open-source system designed to help individuals and organizations achieve their goals through gamification. This project aims to enhance motivation and engagement by introducing game-like mechanics in non-game contexts. \n\nBuilt with **FastAPI** (Python) and utilizing **PostgreSQL** as the database, the project is managed with **Poetry** for dependency management. Docker and Kubernetes configurations are provided to simplify deployment and scaling.\n\n## Key Features ✨\n\n- 🚀 **FastAPI-based**: High-performance API with Python’s FastAPI framework.\n- 🛠️ **Modular Design**: Clean architecture, easily extendable.\n- 🐋 **Docker Support**: Ready-to-use Docker and Docker Compose setups.\n- ☸️ **Kubernetes Ready**: Configuration provided for Kubernetes deployment.\n- ✅ **Comprehensive Testing**: Fully integrated testing suite with `pytest` and Codecov for coverage tracking.\n\n## Quick Start ⚡\n\nTo get started quickly, follow these steps to set up the project locally.\n\n### 1. Clone the repository\n\n```bash\ngit clone https://github.com/fvergaracl/GAME.git\ncd GAME\n```\n\n### 2. Install dependencies with Poetry\n\nMake sure you have Poetry installed, then run:\n\n```bash\npoetry install\n```\n\n### 3. Setup environment variables\n\nCopy the sample environment variables file and configure it as needed:\n\n```bash\ncp .env.sample .env\n```\n\n### 4. Run the application\n\nStart the FastAPI development server:\n\n```bash\npoetry run uvicorn app.main:app --reload\n```\n\nYou can access the application at `http://localhost:8000`.\n\n### 5. Access the API documentation\n\nSwagger UI is available at `http://localhost:8000/docs` for easy API interaction and testing.\n\n## Project Structure 📂\n\nThe GAME project follows a clean and modular structure to ensure maintainability and scalability. Below is an overview of the main components:\n\n```\n.\n├── app                             # Main application directory\n│   ├── api                         # API route definitions\n│   ├── core                        # Core configurations and utilities\n│   ├── models                      # Database models\n│   ├── schemas                     # Pydantic schemas for validation\n│   ├── services                    # Business logic and service layer\n│   └── tests                       # Unit and integration tests\n├── docker                          # Docker-related files\n├── k8s                             # Kubernetes configuration files\n├── migrations                      # Alembic migrations\n├── pyproject.toml                  # Poetry configuration file\n└── README.md                       # Project documentation\n```\n\nFor a more detailed explanation of the project structure, check out the [SETUP.md](SETUP.md) file.\n\n\n## Want to Contribute? 💡\n\nWe welcome contributions of all kinds! Whether you want to fix a bug, improve the documentation, or add a new feature, we encourage you to join the project.\n\nCheck out the [CONTRIBUTING.md](CONTRIBUTING.md) guide for more details on how to contribute.\n\n\n## Running Tests 🧪\n\nThe project includes a suite of unit and integration tests to ensure code quality. To run the tests, use:\n\n```bash\npoetry run pytest\n```\n\nFor coverage reporting, use:\n\n```bash\npoetry run pytest --cov=app --cov-report=term-missing\n```\n\nYou can find more detailed information on testing in the [TESTING.md](TESTING.md) file.\n\n\n## Deployment 🚀\n\n### Docker\n\nFor local development and production environments, you can use Docker. To bring up the application with Docker Compose, run:\n\n```bash\ndocker-compose up --build\n```\n\nFor more details, refer to the [DOCKER_SETUP.md](DOCKER_SETUP.md) file.\n\n### Kubernetes\n\nThe project is ready to be deployed to Kubernetes. You can find the configuration files in the `kubernetes/` directory. Follow the steps in the [KUBERNETES_SETUP.md](KUBERNETES_SETUP.md) for detailed instructions.\n\n\n\n## License 📜\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n\n## Contact\n\nFor any questions or feedback, feel free to open an issue or start a discussion in the [GitHub Issues](https://github.com/fvergaracl/GAME/issues) section. You can also check out our official documentation: [GAME Docs](https://fvergaracl.github.io/GAME).\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvergaracl%2Fgame","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffvergaracl%2Fgame","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvergaracl%2Fgame/lists"}