ethereum-push-notification-service / push-website Goto Github PK

Frontend Website for PUSH

Home Page: https://push-website.vercel.app

CSS 2.81% JavaScript 12.34% TypeScript 84.84% HTML 0.01%

push-website's Introduction

Overview

This repo houses Push protocol's website, documentation and blogs. More info below on how to run the website or submit PRs for new documentation, blog or website pages.

Installation

$ yarn install

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Serve Build

$ npm run build && npm run serve

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

How to submit new documentation

All assets (Images, etc) should be put under /static/assets/docs/{relativeproduct}/{relativefolder}/{relativearticle}

for example: if you are creating tutorial for creating channel under notifications, then images for them should be under /static/assets/docs/notifications/tutorials/create-channel

Feel free to create a folder for a relative document incase needed.
We follow numbering format and specific format for folder structure, article structure and positioning, do make sure that you are aware of those, refer existing articles for more understanding.
You don't have to put a preview image for any documentation as any .mdx file under the /docs will automatically generate a preview image.
Avoid adding custom components unless really required.
Use live playground to ensure builders can play with the code.
Use modern standards for images (aivf, webp) wherever possible.
Ensure consistency is maintained with other articles that are written.
Ensure you know how front matter of Docusaurus works. Recommended to read about front matter from Docusaurus for best practices.
Once you are done with the article, raise a PR and a team member will review -> merge -> deploy the website with your newly added docs.

How to submit new blog

All blogs go in /blog section. Each blog is a seperate folder that follows the naming convention of yyyy-mm-dd-blog-short-title-in-kebab-case
Cover images and any other images goes inside this folder.
All images need to follow modern standards (webp or aivf).
Create an index.md inside this folder struture and write you blog here.
Ensure you are aware of all the meta tags that you have to provide. Make sure you are aware of all standards mentioned here and include them in the blog.
All authors should be included in /blog/authors.yml and author images should be placed in /assets/blog/authors/.
Once you are done with the article, raise a PR and a team member will review -> merge -> deploy the website with your newly added blogs.

How to submit new webpage

All webpage go in /src/pages section.
All custom components go in src/components section.
You can build .mdx markdown page as well. Follow this Docusaurus tutorial on How to build a page for more info.
Ensure images are of modern format (aivf, webp) and are stored under /static/assets/website/{relevant_folder} or for custom components under /static/assets/src/{relevant_folder}
Once you are done with the article, raise a PR and a team member will review -> merge -> deploy the website with your newly added blogs.

Useful commands

Convert all pngs to webp (Mac Terminal)

Browse to that folder and run for file in *; do cwebp -q 80 "$file" -o "${file%.*}.webp"; done

Useful references

https://theochu.com/docusaurus/styling/

Credits

This website is built using Docusaurus 2. a modern static website generator.

push-website's People

Contributors

Stargazers

Watchers

push-website's Issues

In Partners and Collaborators section, EPNS and $EPNS is being used interchangebly

Removing the $ to keep it consistent with EPNS.
$ reserved for referring to the Token name $PUSH

Provide correct links to Documentation and Guides

Powered by Push section

https://www.figma.com/file/PzAmXUMOmwS2ljxufwv44m/PUSH-Prototypes?node-id=6333%3A9187&t=d5POgcxJszzSobHz-1

Replacing Powering Communications by with above design. This section includes a 2 stage animation available in the same figma page. UX team can help showcase the animation.

Implement Press Kit Page

Implement Press-Kit Page

Figma File for UI - https://www.figma.com/file/QFTnfLQwFrV3WZy7Oho0jA/presskit?node-id=0%3A1

Migrate Push Doc Hub from Gitbook to Docusaurus

Description

We want to migrate our existing documentation hub from Gitbook to Docusaurus for better SEO, better customisation and added flexibility to create Docs Landing page following our design system

New Doc Hub Design

Add FAQ section to the site

Will provide details about FAQs later. Once shared, we can start working on it

Hi, I was going through the api calls made at app.epns.io in the channel tab. For fetching each channel subscriber count and to check whether the current wallet address is a subscriber or not, the call to https://backend-prod.epns.io/apis/channels/get_subscribers returns the list of all wallet address subscribed to the channel which seems unnecessary as just two properties can solve it

{
  subscriberCount: <number>,
  isSubscribed: true/false
}

I'm not actually aware of the backend infrastructure in place, but pretty sure it's not a good scalable solution.

Update "Push is the missing piece of web3 section"

The design and animation can be found here

Include animations in the push site

New Spline design

Update Alert bar today at 1:45 PM UTC

Change the alert bar message to the following message:

“Superfluid Taps Push to Update Users on Money Streaming, Click to get notified”

[BUG] support contact form is down

Hey guys! I wanted to reach out and make some product suggestions, and get in touch with the epns/push team - however it looks like your sendmail cert expired? You might want to take a look at that 👀