{"id":14956734,"url":"https://github.com/gsquare-org/maggregor","last_synced_at":"2025-10-24T10:30:57.510Z","repository":{"id":153207111,"uuid":"609986631","full_name":"maggregor/maggregor","owner":"maggregor","description":"Data-layer that speeds up MongoDB queries","archived":false,"fork":false,"pushed_at":"2024-04-18T10:12:09.000Z","size":1903,"stargazers_count":12,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-29T09:44:56.580Z","etag":null,"topics":["cache","layer","materialized-view","mongo","mongo-atlas","mongodb","mongodb-database","performance"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maggregor.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":"2023-03-05T20:18:44.000Z","updated_at":"2024-02-08T09:17:54.000Z","dependencies_parsed_at":"2024-04-18T11:49:38.764Z","dependency_job_id":null,"html_url":"https://github.com/maggregor/maggregor","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maggregor%2Fmaggregor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maggregor%2Fmaggregor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maggregor%2Fmaggregor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maggregor%2Fmaggregor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maggregor","download_url":"https://codeload.github.com/maggregor/maggregor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237950826,"owners_count":19392666,"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":["cache","layer","materialized-view","mongo","mongo-atlas","mongodb","mongodb-database","performance"],"created_at":"2024-09-24T13:13:25.045Z","updated_at":"2025-10-24T10:30:57.113Z","avatar_url":"https://github.com/maggregor.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://user-images.githubusercontent.com/32603471/236147320-9c6d40ec-c444-46ce-b6db-9bfed445850a.png\"\u003e\n  \u003cimg alt=\"MaggregorCache light\" src=\"https://user-images.githubusercontent.com/32603471/236147375-5b21bc05-cd61-4177-820a-e116a470c8d6.png\"\u003e\n\u003c/picture\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Maggregor Build](https://img.shields.io/github/actions/workflow/status/maggregor/maggregor/tests.yaml?branch=main\u0026label=Build)](#)\n[![Maggregor Code Coverage](https://codecov.io/gh/maggregor/maggregor/branch/main/graph/badge.svg?token=etcX0aJ1Er)](https://codecov.io/gh/maggregor/maggregor)\n\n\u003c/div\u003e\n\n# Architecture\n[![Maggregor Architecture](https://user-images.githubusercontent.com/32603471/236058294-6f0525bd-cb84-4178-a2c6-cc87d742b0e8.png)](#)\n\n# Quick start\n\n## Docker-compose\n\n### Prerequisites\n\nBefore you begin, make sure you have the following software installed on your machine:\n\n- [Docker](https://docs.docker.com/get-docker/): Install Docker on your machine.\n- [Docker Compose](https://docs.docker.com/compose/install/): Install Docker Compose on your machine.\n\n### Getting Started\n\nTo get started, follow these steps:\n\n- Clone the repository containing the docker-compose.yml file to your local machine.\n- Navigate to the directory where the docker-compose.yml file is located.\n- Open a terminal or command prompt in that directory.\n- Run the following command to start the Docker containers:\n\n```bash\ndocker-compose up\n```\n\n### Configuration\n\nThe docker-compose.yml file defines three services: mongodb-target, mongodb-metadata, and maggregor. Each service is configured with its own settings, such as image name, container name, ports, and environment variables.\n\n| Environment Variable | Description                                                                                       |\n| -------------------- | ------------------------------------------------------------------------------------------------- |\n| PROXY_PORT           | The port number on which the maggregor server will listen for incoming proxy requests to MongoDB. |\n| HTTP_PORT            | The port number on which the maggregor server will listen for HTTP requests for API and UI.       |\n| MONGODB_TARGET_URI   | The URI of the target MongoDB server to which the requests will be forwarded.                     |\n| MONGODB_METADATA_URI | The URI of the MongoDB server where metadata used by maggregor will be used (optional).           |\n\nYou can configure the application by modifying the docker-compose.yml file according to your requirements. For example, you can change the port mappings or update the environment variables to connect to your own MongoDB instances.\n\n# Directory Structure\n\n| Directory | Description                                                                                                   |\n| -------------------- | -------------------------------------------------------------------------------------------------  |\n| `src/core`   | The core database package (cached aggregations)                                                            |\n| `src/parser` | A MongoDB aggregation query parser                                                                         |\n| `src/server` | Proxy the MongoDB Wire Protocol and intercepts Aggregation Pipeline queries                                |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsquare-org%2Fmaggregor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgsquare-org%2Fmaggregor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsquare-org%2Fmaggregor/lists"}