website v2

This commit is contained in:
Kalidou Diagne
2024-04-05 13:01:20 +01:00
parent a47f2bcec6
commit 154d832d49
103 changed files with 9770 additions and 16464 deletions

View File

@@ -7,56 +7,12 @@ This is the React re-write of the PSE website, formally just a landing page.
`npm install`
`npm run start` serves a development server at [http://localhost:8081](http://localhost:8081)
`npm run dev` serves a development server at [http://localhost:8080](http://localhost:8080)
The components live under `/src/components`.
The app live under `/app`.
## 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:
![TLSN_Example](TLSN_Example.png)
#### 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!