-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
83 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# SDK Frontend React Example | ||
|
||
Welcome to the SDK Frontend React Example project, a hands-on guide demonstrating how to leverage the power of Push Protocol in a frontend environment using reactJs. This resource is an invaluable companion for developers keen to integrate Push Protocol into their frontend services. Dive into the code to gain a comprehensive understanding of how to deploy various features of the Push Protocol. | ||
|
||
## Overview | ||
|
||
The `sdk-frontend-react` project offers a practical tutorial on how to set up and configure Push Protocol on a client application, including guidance on managing notifications and interfacing with the blockchain. This includes essential examples related to: | ||
|
||
- Push Notifications | ||
- Push Chat | ||
- Push NFT Chat | ||
- Push UI-Web | ||
|
||
Through these examples, you'll see how these features can be successfully implemented and integrated using Push Protocol. | ||
|
||
## Getting Started | ||
|
||
Embark on your journey with this project by cloning the repository and installing the dependencies: | ||
|
||
```bash | ||
git clone https://github.com/ethereum-push-notification-service/push-sdk.git | ||
cd push-sdk | ||
yarn install | ||
``` | ||
|
||
**_Note_** - We are using `yarn` and **strongly** advise to use yarn 1.x to avoid any NPM issues. | ||
|
||
## Setting up the SDK-Frontend-React | ||
|
||
1. Navigate to the `packages/examples/sdk-frontend-react` directory. | ||
|
||
## Running the SDK-Frontend-React | ||
|
||
### By GUI (preferred) | ||
|
||
1. Click on the `NX console` extension icon in the VSCode sidebar. | ||
2. Click on the `serve` target execute icon under `examples-sdk-frontend-react` | ||
|
||
### By CLI | ||
|
||
1. Navigate to the root level of push-sdk repository. | ||
2. Run `yarn nx serve packages/examples/sdk-frontend-react` |