Skip to content

Updated the example demos #10

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Updated the example demos #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2359606
Updated the example demos
rodkeys Nov 13, 2018
b99f19b
Updated webrelay to work with most recent version of OpenBazaar
rodkeys Oct 16, 2019
d73218d
Updated examples
rodkeys Oct 16, 2019
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
25 changes: 25 additions & 0 deletions examples/01 - browserSubscription/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Subscribing to your Webrelay in the Browser

This example will show you how to subscribe to your webrelay server from your client-side browser. After subscribing to the webrelay you will be able to forward OpenBazaar messages.

![Subscribing to your Webrelay](src/images/tutorialImage.png)


## Setup

This setup assumes you are running the OpenBazaar Webrelay on localhost + port 8080. If you need to update your host edit the "host" input.

```sh
> npm install
> npm start
```

After installing the dependencies you can run the example by opening up index.html in your local browser.

## Special Thank Yous

Thank you to @hoffmabc and @jashot7 for their demos which helped save a lot of time putting this together. This project was meant to be a simplified demo and tutorial to help get developers started with the webrelay.

## Future Updates

This example project will be expanded in the future to include browser messaging, order handling, and more. The goal is to eventually develop a full browser node for OB.
Loading