{"id":21538304,"url":"https://github.com/rarimo/geo-points-svc","last_synced_at":"2026-01-30T21:37:45.736Z","repository":{"id":246803612,"uuid":"822563308","full_name":"rarimo/geo-points-svc","owner":"rarimo","description":"Core service of Points System for Georgia local usage","archived":false,"fork":false,"pushed_at":"2024-10-24T14:35:04.000Z","size":1017,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-16T03:37:47.896Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rarimo.github.io/geo-points-svc/","language":"Go","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/rarimo.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":"2024-07-01T11:37:26.000Z","updated_at":"2024-10-23T16:02:52.000Z","dependencies_parsed_at":"2024-08-26T12:36:21.884Z","dependency_job_id":"79d99c15-b6a9-4fe5-a8b7-a4ec50429a62","html_url":"https://github.com/rarimo/geo-points-svc","commit_stats":null,"previous_names":["rarimo/geo-points-svc"],"tags_count":98,"template":false,"template_full_name":null,"purl":"pkg:github/rarimo/geo-points-svc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fgeo-points-svc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fgeo-points-svc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fgeo-points-svc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fgeo-points-svc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rarimo","download_url":"https://codeload.github.com/rarimo/geo-points-svc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fgeo-points-svc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28919751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T20:25:28.696Z","status":"ssl_error","status_checked_at":"2026-01-30T20:25:13.426Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-11-24T04:11:37.298Z","updated_at":"2026-01-30T21:37:45.705Z","avatar_url":"https://github.com/rarimo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# geo-points-svc\n\n## Description\n\nCore service of Points System for Georgia local usage\n\n## Install\n\n```\ngit clone github.com/rarimo/geo-points-svc\ncd geo-points-svc\ngo build main.go\nexport KV_VIPER_FILE=./config.yaml\n./main migrate up\n./main run service\n```\n\n## API documentation\n\n[Online docs](https://rarimo.github.io/geo-points-svc/) are available.\n\nAll endpoints from docs MUST be publicly accessible.\n\n### Private endpoints\n\nPrivate endpoints are not documented and MUST only be accessible within the\ninternal network. They do not require authorization in order to simplify back-end\ninteractions with Points service.\n\nThe path for internal endpoints is `/integrations/geo-points-svc/v1/private/*`.\n\n### Add referrals\n\nPrivate endpoint to set usage count for genesis referral code or create a new\n_System user_ with genesis referral code. _System user_ is unable to claim events or\nwithdraw, it has `is_disabled` attribute set to `true`, so the client app should\nnot allow it interactions with the system, although it is technically possible\nto do other actions.\n\nPath: `/integrations/geo-points-svc/v1/private/referrals`\nBody:\n```json\n{\n    \"nullifier\": \"0x0000000000000000000000000000000000000000000000000000000000000000\",\n    \"count\": 2,\n    \"infinity\": true\n}\n```\nResponse:\n```json\n{\n  \"referral\": \"kPRQYQUcWzW\",\n  \"usage_left\": 2,\n  \"infinity\": true\n}\n```\n\nParameters:\n- `nullifier` - nullifier to create or edit referrals for\n- `count` - number of referral usage\n- `infinity` - specify if referrals code have unlimited usage count\n\n### Local build\n\nWe do use openapi:json standard for API. We use swagger for documenting our API.\n\nTo open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it\n```\n  cd docs\n  npm install\n  npm run start\n```\nTo build documentation use `npm run build` command,\nthat will create open-api documentation in `web_deploy` folder.\n\nTo generate resources for Go models run `./generate.sh` script in root folder.\nuse `./generate.sh --help` to see all available options.\n\nNote: if you are using Gitlab for building project `docs/spec/paths` folder must not be\nempty, otherwise only `Build and Publish` job will be passed.  \n\n## Running from Source\n\n* Run dependencies, based on config example\n* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`\n* Provide valid config file\n* Launch the service with `migrate up` command to create database schema\n* Launch the service with `run service` command\n\n### Database\nFor services, we do use ***PostgresSQL*** database. \nYou can [install it locally](https://www.postgresql.org/download/) or use [docker image](https://hub.docker.com/_/postgres/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fgeo-points-svc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frarimo%2Fgeo-points-svc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fgeo-points-svc/lists"}