pse.dev/data/projects

Add new project to projects list

1. Create a New Project File:

• Navigate to the [...]/data/projects folder within your project directory.
• Inside this folder, create a new file named [project_name].ts.

2. Add Project Details:

• Open the newly created [project_name].ts file.
• To ensure all necessary parameters are included, use the ProjectInterface template. Here's a basic structure to get you started:

export const project_name: ProjectInterface = {
  id: "project_name",
  image: "",
  name: "This is an example of the project",
  tags: {
    keywords: [],
    themes: [],
    types: [],
    builtWith: [],
  },
}

• Fill in the id, image, name, and tags fields as per your project's details. The tags object includes arrays for keywords, themes, types, and builtWith.

3. Register the New Project:

• Open the projects.ts file located in the same directory or wherever your project's list is maintained.
• Add your new project to the projects array to make it visible:

import { project_name } from './projects/[project_name].ts';

const projects: ProjectInterface[] = [
  // other projects
  project_name,
];

By following these steps, you will successfully add a new project and ensure it is correctly registered and visible.

Show badges in the project card

Badges can be set by setting the themes params, by looking at this example

export const example: ProjectInterface = {
  id: "example",
  image: "",
  name: "This is an example of the project",
  tags: {
    themes: ["play", "build"],
  },
}

This is the result

Show links in project page detail

To add extra link to projects we need to add extraLinks for the projects we are going to add links for. Make sure that for every "themes" value there is a specific "extraLinks" object will all the links.

export const example: ProjectInterface = {
  id: "example",
  image: "",
  name: "This is an example of the project",
  tldr: 'The project one-liner',
  description: 'A longer project description',
  projectStatus: '',
  tags: {
    themes: ["play", "buildWith"],
    keywords: ["Anonymity/privacy", "Voting/governance"],
    types: ["Lego sets/toolkits", "Infrastructure/protocol"],
    builtWith: ["p0tion", "JubjubLib"],
  },
  extraLinks: {
    buildWith: [
      {
        label: "Link to get started",
        url: 'https://google.it"',
      },
    ],
    play: [
      {
        label: "Link to get started",
        url: 'https://google.it"',
      },
    ],
  },
}

This is the result

Project detail now supports markdown

For PSE members who wish to add more information to the project detail, you can now add to the "description" in the {project}.ts.

Supported format:

• Headings
• Table
• more to come in a later release.

Please note the keyword and theme is curated by the comms & design team. If you wish to change, please create a PR.