Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: instructions for updating the Sugar client #252

Merged
merged 2 commits into from
Oct 30, 2024
Merged

docs: instructions for updating the Sugar client #252

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e40ff9e
docs: instructions for updating the Sugar client
eatyourgreens Oct 26, 2024
755de09
Fix a typo
eatyourgreens Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions lib/SugarClient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Sugar Client

A javascript client for [Sugar](https://github.com/zooniverse/sugar), a notification service using web sockets.

## Primus library

This needs to be kept in sync with the Sugar Server's primus package installation whenever the server version updates due to the way the transport client library is embedded into the version of the primus package, https://github.com/primus/primus#client-library

In order to sync this client version with the server we can derive the latest [primus.js](./primus.js) file by [running the sugar server locally](https://github.com/zooniverse/sugar#development-via-docker--docker-compose) and downloading the primus.js file from sugar dev server via the web browser or via `curl -s http:localhost:2999/primus.js > primus.js`.

You can also download `primus.js` from https://notifications.zooniverse.org/primus.js.

You can then replace the local version of `primus.js` with the server dervied one from sugar server and PR to replace it here.