saeveritt / pc-showcase Goto Github PK

This project is aimed at showing interesting blockchain-related projects. Users can share their projects, giving a link URL and some PPC/BTC addresses for donations.

To submit a project to the showcase, follow these steps:

1. Fork this repository;
2. Add your project at the end of projects.json file;
3. Add your project image at the /imgs/projects folder.

• Your project image must be: JPG, PNG or SVG, and must cointain a resolution of 600x400px.
• Coins accepted for donation are: PPC and BTC.
• The max number of tags per project is five.
• A project must be submitted only by its owner (or with explicitly approval of owner). If you found a cool project related to Peercoin, first ask for owner permission before submitting it here.

Here is a sample of the snippet one would add to projects.json file:

{
  "id": 10,
  "name":"My Awesome Project",
  "description":"This is my project description (keep it small).",
  "imageUrl":"1.jpg",
  "link": "http://my-project-url.com/",
  "tags": ["app", "mobile", "ios", "android", "etc"],
  "donation": [
    {
      "symbol": "PPC",
      "address": "PF1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX"
    },
    {
      "symbol": "BTC",
      "address": "1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX"
    }
  ]
}

If you have any question, feel free to open an issue.

In order to run the project locally, you must follow these steps:

1. Make sure to have Node.js installed;
2. Clone this repo;
3. Run npm install;
4. Run npm start to lift server at localhost:3333;
5. Run npm build to build a production version.

A server-side script pulls this git every 30 minutes. In order to update the production website, simply deploy changes to gh-pages branch and wait until the next server pull.