{"id":20189902,"url":"https://github.com/crossbell-box/operatorsync","last_synced_at":"2025-04-10T08:28:29.632Z","repository":{"id":63994738,"uuid":"508901285","full_name":"Crossbell-Box/OperatorSync","owner":"Crossbell-Box","description":"Server for Crossbell xSync","archived":false,"fork":false,"pushed_at":"2024-03-28T09:57:07.000Z","size":775,"stargazers_count":5,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2024-04-14T02:09:07.275Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://xsync.app","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Crossbell-Box.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}},"created_at":"2022-06-30T02:00:14.000Z","updated_at":"2024-04-15T11:47:29.017Z","dependencies_parsed_at":"2023-10-03T03:47:31.155Z","dependency_job_id":"ab7ab03e-971a-49ab-8ab2-67ab2ccd5322","html_url":"https://github.com/Crossbell-Box/OperatorSync","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/Crossbell-Box%2FOperatorSync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2FOperatorSync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2FOperatorSync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2FOperatorSync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Crossbell-Box","download_url":"https://codeload.github.com/Crossbell-Box/OperatorSync/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248184644,"owners_count":21061373,"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-14T03:39:32.709Z","updated_at":"2025-04-10T08:28:29.607Z","avatar_url":"https://github.com/Crossbell-Box.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xSync Server\n\nBackend server for xSync\n\n## Deploy\n\nWe recommend deploying xSync server in docker or kubernetes.\n\n### Requirements\n\n- IPFS-Upload-Relay: Please deploy your own [IPFS-Upload-Relay](https://github.com/NaturalSelectionLabs/IPFS-Upload-Relay) server.\n\n### Docker\n\n1. Copy environment files from `deploy/env/.example` to `deploy/env`\n2. Edit environment files to match your requirements, like:\n   - Set `ETHEREUM_PRIVATE_KEY` to your operator's private key in `worker.env`.\n   - Set `IPFS_ENDPOINT` to your own IPFS-Upload-Relay server's URI (like `https://upload-relay.example.ltd`).\n   - Edit other fields in different files (like rsshub.stateful.env) for rsshub with platforms logged in\n3. Build services by `make build-docker`\n4. Start services by `make prod-start`\n\nFor more details, please refer to Makefile.\n\n### Kubernetes\n\n\u003e Refer to [.github/workflows/docker-build-push.yml](https://github.com/Crossbell-Box/OperatorSync/blob/develop/.github/workflows/docker-build-push.yml) \n\n## Develop\n\nThis server parse users' RSS feeds to structured data, and then post them on chain.\n\n### Prepare development environment\n\n1. Make sure you've installed both docker and docker-compose.\n2. Start deps by `make dev`\n\n### Add a new platform\n\n1. Edit `SUPPORTED_PLATFORM` in `common/consts/platform.go`, add target platform's basic information.\n2. Create a new directory under `app/worker/platforms/`.\n3. We need to implement 2 functions, one for account validate and the other for feed collect. For implementing details, please refer to other platforms.\n4. Call account validate func in `app/worker/rpc/jobs/validate_account.go`, and call feed collect func in `app/worker/mq/jobs/dispatch/collect_feeds.go`.\n5. Time to test :tada:\n\nIf there's any further questions, please open an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossbell-box%2Foperatorsync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrossbell-box%2Foperatorsync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossbell-box%2Foperatorsync/lists"}