brave/ sync

(v1.4.2) over 3 years ago

JavaScript

HTML

Shell

View on GitHub

Need help with sync?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

brave

208 Stars

51 Forks

Mozilla Public License 2.0

451 Commits

79 Opened issues

Description

deprecated Brave sync server. (sync now uses a fork of the Chromium sync protocol.)

Services available

Need anything else?

Contributors list

Readme

Brave Sync

Name: sync
Brand: sync
SKU: //brave/sync
Rating: 2.27 (208 reviews)

A client/server for Brave sync

Building

Install dependencies:

npm install

Build a bundled JS library for the client:

npm run build

Run the server:

npm run start

Testing

The sync client uses Browserify to transform Node js into browser js. To unittest the library in a browser (default: electron), run

npm run browsertest

. To test in a different browser run

npm run browsertest -- --browser chrome

. Results appear in both the browser inspector and your terminal.

To run tests in Node, just do

npm test

To do a basic client/server integration test against the production server, run

npm run client

and navigate to

http://localhost:8000/

). The page should not show any 'ERROR' messages and should end with 'success'.

Development

Server

server/config

contains settings; defaults in defaults.json and environment variable mappings in custom-environment-variables.json.

To configure locally you can create a file

config-dev.sh

and

source config-dev.sh

when needed:

#!/bin/bash
export AWS_ACCESS_KEY_ID="{stuff}"
export AWS_SECRET_ACCESS_KEY="{secret stuff}"

Run the server with file watching and autoreloading:

sh
npm run start-dev

Client integration

To integrate Brave sync on a platform (iOS, Android, Laptop):

Make a new branch.
In the main browser process, implement an IPC message handler as specified in
```
client/constants/messages.js
```
.
If webviews on your platform do not support
```
chrome.ipcRenderer.{send, on}
```
, edit
```
client/polyfill/chrome.js
```
as needed to polyfill this functionality.

Building for browser-laptop

Make sure this repo is checked out next to
```
browser-laptop/
```
Checkout the
```
feature/syncing
```
branch in browser-laptop
```
npm run dist
```
If developing, do
```
npm start
```
in browser-laptop. Console messages from the sync client will be logged in
```
Library/Application
Support/brave-development/chrome-debug.log
```
.

Tests

To run tests you need to configure these environment variables:

AWS_REGION
AWSS3BUCKET
AWSACCESSKEY_ID
AWSSECRETACCESS_KEY