helia.io - The Helia project Website.

Welcome to the helia.io Website repo. Most of the website content is data-driven, you can check the data directory to see the sections information bundled as js files.

Internationalization i18n

Incorrect translation, help us fix it!

• 1. Create a Transifex account
• 2. Go to https://www.transifex.com/ipfs/js-ipfs-website/, select a language, find an invalid string and propose a new translation

Missing language? Help us translate!

Everyone can help by translating content at Transifex:

• Go to https://www.transifex.com/ipfs/js-ipfs-website and start translating.
• If your language is missing request it on Transifex.

Synchronizing translations (maintainer task)

Periodically, a maintainer of this repo will need to synchronize translations to ensure everything is up to date. NOTE: The steps below are for admins and can be ignored if you're a translator; all translation work happens in Transifex only.

To download updates of all locales:

$ tx pull -a

Then check if any language is missing in the file intl/config, if so, add a line for missing one.

For example, if you were to add Portuguese, you would only have to add the new language to the locales array:

const locales = [
 'en',
+ 'pt'

Then, to download updates of specific locale:

$ tx pull -l pt

Finally, commit changes to ./src/i18n.js and public/locales/.

Note: Newly added language(s) will be live at js.ipfs.tech as soon as the master branch is updated.

Learn more on how to use Transifex

• Installing the Transifex Client
• Understanding .tx/config file
• Manual sync via Transifex Client
  • Using Transifex with GitHub in Your Development Workflow
  • Syncing a local project to Transifex with the Transifex Client

Listing a talk on the website

You can add your talk to the website by creating a PR. You just need to add an object to the publicationsAndTalks array. Example, if you were to add a new entry, you would have to add the link to your talk and its title:

const publicationsAndTalks = [
  {
    link: 'https://www.youtube.com/watch?v=WK4PIGr3RB8',
    active: true,
    title: 'Progress Report on the Decentralized Web, David Dias'
  },
  {
    link: 'https://www.youtube.com/watch?v=2cmbm6iABsI',
    title: 'IPFS on the Brave Browser, Alan Shaw'
  }
]

Want to show what's possible to build with js-ipfs?

Sharing your app with us is very simple! You just need to host your code on codesandbox and edit apps array. Example, if you want to add a new app, you only have to add a new entry to the apps array by adding its title and the corresponding codesandbox share link:

const apps = [
  {
    title: 'Example 1',
    link: 'https://codesandbox.io/embed/qkj8z9l8kq'
  },
  {
    title: 'Example 2',
    link: 'https://codesandbox.io/embed/vv99onw18y'
  }
]

Development

Dependencies

• Node.js and npm for build tools
• Transifex Client for locales
• ipfs to deploy changes

Install

> git clone https://github.com/ipfs-shipyard/www-helia-io
> npm ci

Usage

The following commands are available:

• npm run start - Starts a hot-reloading development environment at localhost:8000.
• npm run build - Generates the static HTML and JavaScript code bundles by performing a production build.
• npm run lint - Runs aegir lint.

Publish

When a PR gets merged to master, it is deployed to helia.io by Fleek CI.

1. Wait for Fleek CI to build the project and add it to IPFS
2. Finally, go to the constants folder and paste the resulting hash on the heliaWebsite property of the exported object.

License

MIT