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.

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

Notification trigger according to time intervals EthTicker #597

Merged
merged 5 commits into from
Feb 13, 2024

Conversation

Arunava-Barua
Copy link
Collaborator

This PR consists the example documentation of time based notification trigger for the Eth Tracker channel closes #596

@Arunava-Barua Arunava-Barua added the documentation Improvements or additions to documentation label Jan 18, 2024
@Arunava-Barua Arunava-Barua self-assigned this Jan 18, 2024
Copy link

vercel bot commented Jan 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
push-website ❌ Failed (Inspect) Feb 13, 2024 6:06am


# Slider Notification Settings in Showrunners

This example is intended to get you understand slider based notification settings with a real-world application. For the example we are going to look at a scenario where users can choose a time interval and showrunners framework will notify them as per their request. Checkout [Showrunners Docs](https://push.org/docs/notifications/showrunners-scaffold/get-started/), [Showrunners Framework](https://github.com/ethereum-push-notification-service/push-showrunners-framework/tree/main), [Channel Settings Docs](https://push.org/docs/notifications/build/create-channel-settings/) and [Channel Settings Demo](https://github.com/ethereum-push-notification-service/push-showrunners-framework/tree/main/src/sample_showrunners/bank) for better understanding!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url should follow relative markdown format, ie /docs/.... also include description in "". For example:

Showrunners Docs


Imagine you are a crypto trader or a general crypto enthusiast. You want to be notified every once in a while about the price movements and activities in the market. But you either lose track of time or forget about it. To solve this exact problem, we will be looking into a slider type notification settings implementation where you as a user can specify the time interval after which you would like to get notified.

We will choose the [Eth Tracker](https://github.com/ethereum-push-notification-service/push-showrunners-channels/tree/wallet-tracker/Staging_channels/ethTicker) channel to demonstrate this example.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Url should include title in markdown format for example ETH Tracker


### Setup the Showrunners in your local machine

For detailed, step-by-step guide visit the Showrunners [docs](https://push.org/docs/notifications/showrunners-scaffold/get-started/). First we need to create a folder in `src/showrunners/<your_channel_name>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Url should include title in markdown format for example ETH Tracker


### Import the Push SDK

After you have created a channel folder. Refer to Showrunners [docs](https://push.org/docs/notifications/showrunners-scaffold/get-started/). Move to the [name]Channel.ts file and import the dependencies.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Url should include title in markdown format for example ETH Tracker

@HarshRajat HarshRajat merged commit 9e5602e into main Feb 13, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Notification trigger based on time interval example
2 participants