Installation

To install all local dependencies located in package.json use:

yarn

Website

1. ENVs

To populate project with environment variables create files .env.development for local development and .env.production for final build.

2. Local development

yarn start

Local server will start on http://localhost:8000/

3. Build

To build Gatsby project run:

yarn build

After the process is complete, production files will be located in the public folder located in the root of the project.

Branding

Assets

All Branding assets are available in joystream design repository. In case any of them changes, a script should be ran to include changes on the joystream branding page, and any changes introduced by it should be commited and deployed.

Assets refresh script:

yarn fetch-assets-data

Roadmap data

Roadmap data can be found in the following file(s): src/data/quarters/${roadmap-data-name}.json

To update the data, just directly edit the file you want to change the data for.

To add a new version of the roadmap, you can follow these steps:

• Add new file in the aforementioned folder (e.g., src/data/quarters/2024-2025.json)
• The roadmap file should follow this structure:

  • [{
      "language",
      "quarters": [{
        "year",
        "id",
        "deliveryMilestones": [{
          "icon",
          "title",
          "Content"
        }]
      }]
    }]

  • In case of doubts and to also get a better idea for how this data should look exactly, you can consult one of the roadmap files that are already there.
  • As for the "icon" values, these values represent icons that can be found in the assets of the project. More specifically, for the map of "key" (i.e., in this case the icon string value) to the "value" (i.e., the icon itself) you can consult the iconMap object in the following file: src/data/quarters/index.js.
• As the final step, the exported array within the src/data/quarters/index.js file needs to be expanded with an object following this structure: { "select": { "title", "subtitle" }, "name", "value", "isNewest" }
  • Note: Only one object should have the "isNewest" property set to true.

Glossary data

Glossary data can be found in the following file: src/data/glossary/glossary.json

When updating the glossary or adding new terms to it, this structure should be followed:

  [{
    "language":
    "terms": [{
      "title",
      "tooltip",
      "content",
      "nodes": [{
        "title",
        "content": [""]
      }],
      "others": [{
        "title",
        "subtitle",
        "content": [""]
      }],
      "relatedTerms": [""]
    }]
  }]

Important note: The glossary is automatically populated into the roadmap at runtime. The way this is done is that the term title is checked for in the content of a roadmap item and replaced with an underlined item with a tooltip. It is therefore important to make sure that the spelling of each title term is correct.

Verification data

Verification data can be found in the following file: src/data/pages/verification.js.

Within this file is an array with the name of verifiedMembers. To add new members one needs to expand the array with an object of the following structure:

{
  memberHandle: 'vikan#4315',
  substituteUserRoute: 'vikan',
  avatarUrl: 'https://raw.githubusercontent.com/Joystream/founding-members/main/avatars/primary-avatar/90.png',
  title: 'verification.title.outreachSpecialist',
  socials: {
    telegram: '@vikan393',
    twitter: '@jvikan1',
    email: 'vikan4joystream@gmail.com',
    discord: '@v.i.k.a.n',
  },
  safety: {
    notAllowed: [
      { text: 'verification.safety.willNever.items.askForMoney' },
      { text: 'verification.safety.willNever.items.askForPasswordsOrSensitiveInformation' },
      { text: 'verification.safety.willNever.items.sendAnythingDangerous' },
      {
        text: 'verification.safety.willNever.items.askToVisitLinks',
        components: [{ link: 'https://www.joystream.org', text: 'Joystream.org' }],
      },
    ],
    allowed: [{ text: 'verification.safety.can.items.inviteToYpp' }],
  },
},

To edit members, one just needs to update the objects that are already there to the new desired values.

Things to keep note of:

• The verification page will use the memberHandle object property value as the route on the website for this specific profile. If that value is not a valid path value then the substituteUserRoute value is used instead. This should be removed when not in use.
• The safety list items and title have special strings as text (e.g., verification.title.outreachSpecialist). These strings are used to allow for internationalization and are replaced based off of the language set by the user with correct translations. To reference those that are already pre-written/available, you can find the translations for this page on here: src/locales/en/verification.json under safety.can... and safety.willNever.... If there isn't a translation that matches one that you want to add, you are free to create one with regular english language sentences and these translations will be created by the dev during the PR process.

This section outlines the steps to control the visibility of the "History" section on the dashboard page.

Functionality:

• toggling the historyHidden flag, located in /pages/dashboard/index.js, controls the visibility of the "History" section on the dashboard;
• when the flag is set to true, the section is hidden, and the corresponding "History" anchor is removed from the navigation;
• conversely, setting the flag to false displays the section and adds the "History" anchor back to the navigation.

This section details the process of populating the "History" section on the dashboard page with data retrieved from an API.

Data Parsing:

• DashboardHistory component expects data to be passed through the data prop;
• create a dedicated utility function within src/components/dashboard-page/History/data.js to handle API data parsing;
• this function should transform the raw API response into an array of objects structured as follows:
  • img - URL of the image associated with the history entry;
  • date - Date of the history entry;
  • shortDescr - Short description of the history entry;
  • longDescr - Optional longer description of the history entry;
• import the parsing function into src/components/dashboard-page/History/data.js;
• pass the fetched API data as an argument to the parsing function.

The function will return the processed data in the required format.