{"id":13451891,"url":"https://github.com/brave/sync","last_synced_at":"2025-03-23T19:33:12.179Z","repository":{"id":68472390,"uuid":"74005806","full_name":"brave/sync","owner":"brave","description":"deprecated Brave sync server. (sync now uses a fork of the Chromium sync protocol.)","archived":true,"fork":false,"pushed_at":"2020-07-29T20:57:15.000Z","size":3102,"stargazers_count":204,"open_issues_count":79,"forks_count":41,"subscribers_count":26,"default_branch":"staging","last_synced_at":"2025-03-19T06:54:36.606Z","etag":null,"topics":["brave-sync","javascript","sync"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brave.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-11-17T08:24:52.000Z","updated_at":"2024-09-26T22:05:10.000Z","dependencies_parsed_at":"2023-03-11T03:42:46.967Z","dependency_job_id":null,"html_url":"https://github.com/brave/sync","commit_stats":{"total_commits":334,"total_committers":20,"mean_commits":16.7,"dds":0.6676646706586826,"last_synced_commit":"a3a4ec4ad11bb6622bce054498367e6bc8a0ec26"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brave%2Fsync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brave%2Fsync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brave%2Fsync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brave%2Fsync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brave","download_url":"https://codeload.github.com/brave/sync/tar.gz/refs/heads/staging","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245158762,"owners_count":20570249,"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":["brave-sync","javascript","sync"],"created_at":"2024-07-31T07:01:06.074Z","updated_at":"2025-03-23T19:33:11.701Z","avatar_url":"https://github.com/brave.png","language":"JavaScript","readme":"# Brave Sync\n\n[![Build\nStatus](https://travis-ci.org/brave/sync.svg?branch=master)](https://travis-ci.org/brave/sync)\n\nA client/server for Brave sync\n\n## Building\n\nInstall dependencies:\n\n```\nnpm install\n```\n\nBuild a bundled JS library for the client:\n\n```\nnpm run build\n```\n\nRun the server:\n\n```sh\nnpm run start\n```\n\n## Testing\n\nThe sync client uses Browserify to transform Node js into browser js. To unittest\nthe library in a browser (default: electron), run `npm run browsertest`.\nTo test in a different browser run `npm run browsertest -- --browser chrome`.\nResults appear in both the browser inspector and your terminal.\n\nTo run tests in Node, just do `npm test`.\n\nTo do a basic client/server integration test against the production server, run\n`npm run client` and navigate to `http://localhost:8000/`). The page\nshould not show any 'ERROR' messages and should end with 'success'.\n\n## Development\n\n### Server\n\n`server/config` contains settings; defaults in defaults.json and environment variable mappings in custom-environment-variables.json.\n\nTo configure locally you can create a file `config-dev.sh` and `source config-dev.sh` when needed:\n\n```sh\n#!/bin/bash\nexport AWS_ACCESS_KEY_ID=\"{stuff}\"\nexport AWS_SECRET_ACCESS_KEY=\"{secret stuff}\"\n```\n\nRun the server with file watching and autoreloading:\n```sh\nnpm run start-dev\n```\n\n### Client integration\n\nTo integrate Brave sync on a platform (iOS, Android, Laptop):\n\n1. Make a new branch.\n2. In the main browser process, implement an IPC message handler as specified\n   in `client/constants/messages.js`.\n3. If webviews on your platform do not support `chrome.ipcRenderer.{send, on}`,\n   edit `client/polyfill/chrome.js` as needed to polyfill this functionality.\n\n#### Building for browser-laptop\n\n1. Make sure this repo is checked out next to `browser-laptop/`\n2. Checkout the `feature/syncing` branch in browser-laptop\n3. `npm run dist`\n4. If developing, do `npm start` in browser-laptop. Console messages from the\n   sync client will be logged in `Library/Application\n   Support/brave-development/chrome-debug.log`.\n\n### Tests\n\nTo run tests you need to configure these environment variables:\n\n- AWS_REGION\n- AWS_S3_BUCKET\n- AWS_ACCESS_KEY_ID\n- AWS_SECRET_ACCESS_KEY\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrave%2Fsync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrave%2Fsync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrave%2Fsync/lists"}