{"id":20093899,"url":"https://github.com/api3dao/api3-tracker","last_synced_at":"2025-05-06T04:32:20.864Z","repository":{"id":103091695,"uuid":"510700842","full_name":"api3dao/api3-tracker","owner":"api3dao","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-06T19:54:44.000Z","size":1235,"stargazers_count":4,"open_issues_count":11,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-09T08:38:54.280Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/api3dao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2022-07-05T11:08:48.000Z","updated_at":"2025-02-06T19:54:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"8da849af-3354-4cb9-9399-b746a9121b60","html_url":"https://github.com/api3dao/api3-tracker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api3dao%2Fapi3-tracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api3dao%2Fapi3-tracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api3dao%2Fapi3-tracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api3dao%2Fapi3-tracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/api3dao","download_url":"https://codeload.github.com/api3dao/api3-tracker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252622420,"owners_count":21777987,"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":[],"created_at":"2024-11-13T16:48:47.510Z","updated_at":"2025-05-06T04:32:20.857Z","avatar_url":"https://github.com/api3dao.png","language":"TypeScript","readme":"# API3 DAO Tracker\n\nAPI3 DAO Tracker provides a web interface to see\non-chain details of the API3 DAO, including:\n\n- Members, their stakes, shares, voting power, and voting history\n- Proposal details\n- All events from the smart contracts of the API3 DAO\n- DAO Treasuries status\n\n## Architecture\n\nThe app relies on Terraform to configure a generic Linux EC2 instance.\nThe EC2 instance in-turn hosts Docker, and app-services are orchestrated by Docker directly (eg. `restart=always`).\n\nThe services are:\n\n```\n(end user) -\u003e Cloudflare -\u003e EC2 IP -\u003e traefik (load balancer) -\u003e api3-tracker (container)\n```\n\nContainers:\n\n- api3tracker: The FE and BE-service\n- postgres: The database the FE and BE rely on\n- traefik: A load balancer that encrypts HTTP responses (using the CF origin server key pair)\n- postgres-exporter: a service that exports the database as a backup on an interval\n\nHost services:\nThe host OS also runs some cron services, these are:\n\n```bash\n*/10 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 ./bin/job_logs_download.sh \u003e\u003e /var/log/api3-logs-download.log 2\u003e\u00261\n15,45 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 ./bin/job_supply_download.sh \u003e\u003e /var/log/api3-supply-download.log 2\u003e\u00261\n0 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 ./bin/job_treasuries_download.sh \u003e\u003e /var/log/api3-treasuries-download.log 2\u003e\u00261\n2,12,22,32,42,52 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 ./bin/job_state_update.sh \u003e\u003e /var/log/api3-state-update.log 2\u003e\u00261\n10 0 * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 ./bin/job_shares_download.sh --tag . \u003e /var/log/api3-shares-download.log 2\u003e\u00261\n24 4 * * */3 root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod \u0026\u0026 bash ./bin/postgres-backup.sh \u003e\u003e /var/log/postgres-backups.log 2\u003e\u00261\n```\n\n## Local developement using Docker\n\nDevelopers can run some or all services locally using Docker Swarm, or even bare-bones, without containerisation.\n\nOne combination is running just postgres locally using Docker, eg:\n\n```bash\ndocker run --rm -ti -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres:15\n```\n\nand then running the FE and BE services directly (refer to Cron jobs below and `yarn dev` in `package.json`).\n\nAlternatively, one can run services using Docker Swarm, but this lacks hot-reloading.\n\n### Local development using Docker Swarm\n\nIf you haven't already enabled Swarm mode on your Docker instance, do so now (only has to be done once):\n\n```bash\ndocker swarm init\n```\n\nThe result of the above command can be ignored.\n\nBuild the FE/BE image:\n\n```bash\ndocker build -t api3dao/api3-tracker:latest .\n```\n\nRun the stack:\n\n```bash\ndocker stack deploy -c dev-tools/docker-compose.yml tracker-stack\n```\n\nIf all goes well the application will be served at http://localhost:3000\n\nSome commands for visualising the services:\n\n```bash\ndocker ps # all docker containers\ndocker service ls # all swarm services\ndocker service ps tracker-stack_postgres --no-trunc # show status of postgres\ndocker stack rm tracker-stack # tear down the stack\n```\n\nInitialise the DB:\n\n```bash\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" yarn prisma migrate deploy\n```\n\nCron jobs (unwrapped versions of cronjobs):\n\n```bash\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node -T cli.ts logs download\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node -T cli.ts supply download\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node -T cli.ts treasuries download\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node -T cli.ts shares download\nDATABASE_URL=\"postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable\" API3TRACKER_ENDPOINT=\"ARCHIVE RPC URL\" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node -T cli.ts state update --rps-limit\n```\n\nKeep in mind that the Postgres DB in the docker-compose file is not configured with a volume by default, so changes will be lost on service restart.\n\n## Local Installation and Deployment (Terraform only)\n\nThe only requirements for installation are [Docker](https://docs.docker.com/get-docker/)\nand [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli).\n\nYou may also need\n[AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\nif you want the AWS S3 backups to be enabled on your environment\n\nSome scripts also rely on [cURL](https://curl.se/) and [JQ](https://jqlang.github.io/jq/)\n\n1. Prepare docker image of API3 Tracker with `make build install`\n2. Please go to `terraform/workspaces/api3tracker-local` and apply\n   terraform plan `terraform init \u0026\u0026 terraform apply`. You should see\n   all resources that will be installed on your system.\n   You can also check running components with `docker ps`.\n   Default local environment starts website at [http://localhost:7040](http://localhost:7040).\n3. Run `./bin/postgres-download.sh` to download the latest database backup\n   from AWS S3. As the database syncing is extremely slow and can take weeks,\n   you should take database that is ready for development\n\n## Local Development\n\nOnce you have local terraform installation, you may run\n\n```sh\n# download dependencies\nyarn\n# save database credentials from terraform plan (Linux only)\n# if you are not usign Linux, put DATABASE_URL in .env manually\nmake env\n# start local development server\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000)\nwith your browser to see the result.\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapi3dao%2Fapi3-tracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapi3dao%2Fapi3-tracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapi3dao%2Fapi3-tracker/lists"}