https://github.com/privacy-scaling-explorations/website
Privacy and Scaling Explorations
https://github.com/privacy-scaling-explorations/website
ethereum privacy react reactjs research-and-development zero-knowledge
Last synced: about 1 year ago
JSON representation
Privacy and Scaling Explorations
- Host: GitHub
- URL: https://github.com/privacy-scaling-explorations/website
- Owner: privacy-scaling-explorations
- Created: 2022-03-28T15:38:08.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-20T10:19:10.000Z (almost 3 years ago)
- Last Synced: 2025-03-26T13:38:24.232Z (over 1 year ago)
- Topics: ethereum, privacy, react, reactjs, research-and-development, zero-knowledge
- Language: TypeScript
- Homepage: https://appliedzkp.org
- Size: 3.39 MB
- Stars: 12
- Watchers: 5
- Forks: 18
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](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:
``` json
{
"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](https://github.com/AtHeartEngineering/pse_landingpage/issues/new).
### Have an idea?
Create an [issue](https://github.com/AtHeartEngineering/pse_landingpage/issues/new) 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](http://projects.appliedzkp.org)