Giter VIP home page Giter VIP logo

pse_landingpage's Introduction

Privacy and Scaling Explorations

Main branch served at: https://projects.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:

TLSN_Example

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

pse_landingpage's People

Contributors

atheartengineer avatar chancehudson avatar thebeyondr avatar chialit avatar cedoor avatar glamperd avatar jacque006 avatar janmajayamall avatar catsnackattack avatar cperezz avatar jzaki avatar thefrozenfire avatar tkmct avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.