From 21fadde9914d7da5f476e21e3ca8fde062659fff Mon Sep 17 00:00:00 2001 From: sumith prabhu Date: Mon, 16 Oct 2023 08:56:52 +0530 Subject: [PATCH 1/6] Redame changed --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 71 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 079cf65..47edfc7 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,59 @@ +

+ + + + + + +

+ +

+ Push Protocol is a web3 communication network, enabling cross-chain notifications, messaging, video, and NFT chat for dapps, wallets, and services.🚀 +

+ +

+ + + discord + + + twitter + + + youtube + +

+ + # PUSH Showrunners (Server) The PUSH Showrunners handles the channels created and maintaned by us. It also shows how easy it is to interact with the protocol to build highly customized notifications for your dApp, smart contracts or even centralized services. +--- + ## Installation and Set Up Guide - Install docker - Clone the repo -``` git clone https://github.com/ethereum-push-notification-service/epns-showrunners-staging-v2.git``` +``` +git clone https://github.com/ethereum-push-notification-service/epns-showrunners-staging-v2.git +``` - Open the root folder in a terminal and enter ```docker-compose up```. This initalises mongodb, redis and ipfs local instances - Open the root folder in another terminal and enter -```npm install``` -```npm start``` +``` +npm install +``` +``` +npm start +``` ### To exit - To stop running the showrunners server, press ```Ctrl + C``` - To stop running the docker, press ```Ctrl + C``` and enter ```docker-compose down``` +--- ## Showrunner Channels @@ -27,6 +63,8 @@ The PUSH Showrunners handles the channels created and maintaned by us. It also s - The alpha protocol and product are working and are in ropsten network - **Have an idea for protocol or product?** Awesome! get in touch by joining our [Telegram Group](https://t.me/epnsproject) or following us on [Twitter](https://twitter.com/epnsproject) +--- + ## Technical Details Following definitions are used in the rest of the spec to refer to a particular category or service. @@ -59,3 +97,33 @@ We would need external services of: For local ease of development, we make use of [Docker](https://docs.docker.com/get-docker/). +--- + +## Resources +- **[Website](https://push.org)** To checkout our Product. +- **[Docs](https://docs.push.org/developers/)** For comprehensive documentation. +- **[Blog](https://medium.com/push-protocol)** To learn more about our partners, new launches, etc. +- **[Discord](https://discord.gg/pushprotocol)** for support and discussions with the community and the team. +- **[GitHub](https://github.com/ethereum-push-notification-service)** for source code, project board, issues, and pull requests. +- **[Twitter](https://twitter.com/pushprotocol)** for the latest updates on the product and published blogs. + +--- + +## Contributing + +Push Protocol is an open source Project. We firmly believe in a completely transparent development process and value any contributions. We would love to have you as a member of the community, whether you are assisting us in bug fixes, suggesting new features, enhancing our documentation, or simply spreading the word. + +- Bug Report: Please create a bug report if you encounter any errors or problems while utilising the Push Protocol. +- Feature Request: Please submit a feature request if you have an idea or discover a capability that would make development simpler and more reliable. +- Documentation Request: If you're reading the Push documentation and believe that we're missing something, please create a docs request. + +Not sure where to start? Join our discord and we will help you get started! + + +Discord + +--- + +## License +Check out our License HERE + From ac6c71e857cca46c8abbbaf63cbead3bf6abaf09 Mon Sep 17 00:00:00 2001 From: sumith prabhu Date: Mon, 16 Oct 2023 10:12:41 +0530 Subject: [PATCH 2/6] Readme Updated --- README.md | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 47edfc7..820469d 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ # PUSH Showrunners (Server) -The PUSH Showrunners handles the channels created and maintaned by us. It also shows how easy it is to interact with the protocol to build highly customized notifications for your dApp, smart contracts or even centralized services. +The showrunners framework is a scaffold that developers can use to build out notifications for their use cases. Showrunners framework provides the tools and helpers required for constructing the payload and sending the notification using the Push protocol infrastructure. --- @@ -38,8 +38,10 @@ The PUSH Showrunners handles the channels created and maintaned by us. It also s ``` git clone https://github.com/ethereum-push-notification-service/epns-showrunners-staging-v2.git ``` -- Open the root folder in a terminal and enter -```docker-compose up```. This initalises mongodb, redis and ipfs local instances +- Open the root folder in a terminal and enter toc initalises mongodb, redis and ipfs local instances +``` +docker-compose up +``` - Open the root folder in another terminal and enter ``` npm install @@ -54,23 +56,45 @@ npm start ```docker-compose down``` --- +## Channel Structure +Before we dive into an example ,Let's understand the requirements for the folder structure inside the src/showrunners folder and how you can use them to quickly refine / debug / deploy your channels. + +Each folder inside ```src/showrunners``` is treated as their own channel. Showrunners is designed to be a plug and play solution for your channel which means that each of the folders designated filenames are used to add-on various functionalities. + +1. channelChannel.js [.ts] (Mandatory) + - Example: helloWorldChannel.js + - This file contains all the logic functions of your channel, it can for instance have a way to poll all opted in users of your channel and based on certain conditions that are met, fire notifications out. +1. channelKeys.json (Mandatory) + - Example: helloWorldKeys.json + - This file contains all your private keys that you either belong to the channel you created or have authorized the wallets to send notification on your channel's behalf. +1. channelRoutes.js [.ts] + - Example: helloWorldRoutes.js + - This file contains the routes that you will enable to ensure you are able to manually trigger notification or any other logic points in your channelChannel.js [.ts] + - You will ideally use the route of this files in postman to trigger logic functions / test them out. +1. channelJobs.js [.ts] + - Example: helloWorldJobs.js + - This file contains your cron jobs to trigger logic points in your channelChannel.js [.ts] + - The file is based on node-schedule and can handle a wide variety of automated cron jobs to enable sending wide array of notifications based on triggers. +1. channelAWSSNS.js[.ts] + - Example: helloWorldAWSSNS.ts + - This file contains the webhook helpers and handle the logic points for consuming a webhook. + - This file is based on AWS-SNS and can handle the variety of logics for consuming webhook to enable sending wide array of notifications based on webhook triggers. -## Showrunner Channels +--- +## Examples : -- To subscribe to channels, please visit our [Alpha dApp](https://app.epns.io) -- Currently notifications can be recieved through our [Google Play Alpha App](https://play.google.com/store/apps/details?id=io.epns.epns) -- The alpha protocol and product are working and are in ropsten network -- **Have an idea for protocol or product?** Awesome! get in touch by joining our [Telegram Group](https://t.me/epnsproject) or following us on [Twitter](https://twitter.com/epnsproject) +Now lets have a quick tour into example and understand How to actually run a Showrunner framework over a demo HelloWorld channel +(Hello World Example)[https://docs.push.org/developers/developer-tooling/showrunners-framework/hello-world-channel] --- ## Technical Details -Following definitions are used in the rest of the spec to refer to a particular category or service. + ### Tech Specs @@ -99,16 +123,6 @@ For local ease of development, we make use of [Docker](https://docs.docker.com/g --- -## Resources -- **[Website](https://push.org)** To checkout our Product. -- **[Docs](https://docs.push.org/developers/)** For comprehensive documentation. -- **[Blog](https://medium.com/push-protocol)** To learn more about our partners, new launches, etc. -- **[Discord](https://discord.gg/pushprotocol)** for support and discussions with the community and the team. -- **[GitHub](https://github.com/ethereum-push-notification-service)** for source code, project board, issues, and pull requests. -- **[Twitter](https://twitter.com/pushprotocol)** for the latest updates on the product and published blogs. - ---- - ## Contributing Push Protocol is an open source Project. We firmly believe in a completely transparent development process and value any contributions. We would love to have you as a member of the community, whether you are assisting us in bug fixes, suggesting new features, enhancing our documentation, or simply spreading the word. From e3bcb8fc90f4fd90373cf076ffe0d64d3254785e Mon Sep 17 00:00:00 2001 From: sumith prabhu Date: Mon, 16 Oct 2023 10:14:02 +0530 Subject: [PATCH 3/6] Link changed --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 820469d..6340ef2 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,8 @@ Each folder inside ```src/showrunners``` is treated as their own channel. Showru ## Examples : Now lets have a quick tour into example and understand How to actually run a Showrunner framework over a demo HelloWorld channel -(Hello World Example)[https://docs.push.org/developers/developer-tooling/showrunners-framework/hello-world-channel] + +[Hello World Example](https://docs.push.org/developers/developer-tooling/showrunners-framework/hello-world-channel) --- From 21d9189197a6fa07159c5c058c3702bc785c3974 Mon Sep 17 00:00:00 2001 From: sumith prabhu Date: Mon, 16 Oct 2023 10:56:48 +0530 Subject: [PATCH 4/6] Readme Updated --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6340ef2..83643ff 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The showrunners framework is a scaffold that developers can use to build out not ``` git clone https://github.com/ethereum-push-notification-service/epns-showrunners-staging-v2.git ``` -- Open the root folder in a terminal and enter toc initalises mongodb, redis and ipfs local instances +- To make it easier to use, we will be using Docker. You can initialize it using the code below code , but if looking for a manual setup then [Refer this](#external-services). ``` docker-compose up ``` @@ -97,7 +97,7 @@ Now lets have a quick tour into example and understand How to actually run a Sho | ------------- | ------------- | | Showrunners | Showrunners are Channels on PUSH protocol notification protocol that are created and maintained by us | --> -### Tech Specs + -### External Services +## External Services We would need external services of: From c2c3faa52f4100ff57d513f2f1a3464a7da13423 Mon Sep 17 00:00:00 2001 From: sumith prabhu Date: Fri, 20 Oct 2023 10:16:45 +0530 Subject: [PATCH 5/6] clone link changed --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 83643ff..00cbc6a 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The showrunners framework is a scaffold that developers can use to build out not - Install docker - Clone the repo ``` -git clone https://github.com/ethereum-push-notification-service/epns-showrunners-staging-v2.git +git clone https://github.com/ethereum-push-notification-service/push-showrunners-framework ``` - To make it easier to use, we will be using Docker. You can initialize it using the code below code , but if looking for a manual setup then [Refer this](#external-services). ``` @@ -44,10 +44,10 @@ docker-compose up ``` - Open the root folder in another terminal and enter ``` -npm install +yarn install ``` ``` -npm start +yarn start ``` ### To exit @@ -88,6 +88,8 @@ Now lets have a quick tour into example and understand How to actually run a Sho [Hello World Example](https://docs.push.org/developers/developer-tooling/showrunners-framework/hello-world-channel) +For more examples [Refer this](https://github.com/ethereum-push-notification-service/push-showrunners-framework/tree/main/src/sample_showrunners). + --- ## Technical Details From 3e2130e7e480050881d9abaa2c2e0ce936a5a462 Mon Sep 17 00:00:00 2001 From: Sumith prabhu <91826109+sumithprabhu@users.noreply.github.com> Date: Fri, 5 Apr 2024 16:43:44 +0530 Subject: [PATCH 6/6] github repo changed --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 00cbc6a..9e8cf48 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The showrunners framework is a scaffold that developers can use to build out not - Install docker - Clone the repo ``` -git clone https://github.com/ethereum-push-notification-service/push-showrunners-framework +git clone https://github.com/push-protocol/push-showrunners-framework ``` - To make it easier to use, we will be using Docker. You can initialize it using the code below code , but if looking for a manual setup then [Refer this](#external-services). ``` @@ -88,7 +88,7 @@ Now lets have a quick tour into example and understand How to actually run a Sho [Hello World Example](https://docs.push.org/developers/developer-tooling/showrunners-framework/hello-world-channel) -For more examples [Refer this](https://github.com/ethereum-push-notification-service/push-showrunners-framework/tree/main/src/sample_showrunners). +For more examples [Refer this](https://github.com/push-protocol/push-showrunners-framework/tree/main/src/sample_showrunners). --- @@ -142,5 +142,5 @@ Not sure where to start? Join our discord and we will help you get started! --- ## License -Check out our License HERE +Check out our License HERE