Privacy and Scaling Explorations

Main branch served at: https://appliedzkp.org/

This is the React re-write of the PSE website, formally just a landing page.

Get Started with Development

npm install

npm run start serves a development server at http://localhost:8081

The components live under /src/components.

How to contribute

Add / Change a Project Entry

All the projects are stored in the projects.json file in /src/data/

Here is an example of a project's entry:

{
    "name": "TLS Notary",
    "short_name": "TLSN",
    "description": "Black Magic",
    "long_description": "Black Magic",
    "image": "tlsn.png",
    "links": [
      {
        "github": "https://github.com/tlsnotary/tlsn"
      },
      {
        "discord": "https://discord.gg/EjpvcEaqkh"
      }
    ]
  }

Which results in this project card:

Name / Short Name

name is the name of the project, and short_name is the name that will be used for a placeholder image if an image isn't included or can't be found.

Description / Long Description

description is the description of the project in roughly the size of a tweet (so it fits on the project card), and long_description is the description that will be used for the project's page/pop out card (in the works now).

Project Logos / Images

Project logos/images are stored in /src/images and the file name needs to be listed in the project's entry in projects.json as "image": "filename.png".

Links

Links can be website, github, discord, twitter, or telegram. If you want more options like that added (like Reddit for example), please create an issue.

Have an idea?

Create an issue and tell us the idea!

Want to contribute?

Feel free to fork this repo and make a pull request to the dev branch.

Build and deployment process

1. When a pull request or push is made to the dev branch, github actions builds a static/production version of the site to the gh-pages-dev branch.
2. Once changes have been verified on the gh-pages-dev branch, the dev branch is merged into master where github actions builds and deploys a production version of the site to gh-pages
3. gh-pages is served at http://projects.appliedzkp.org