readme.md

Filecoin Foundation for the Decentralized Web

Note: these docs will be expanded upon in a future iteration of the site

Overview

• This is the repository for the Filecoin Foundation for the Decentralized Web website (ffdweb.org)
• This repo represents a static site which requires compilation, but can then be served as a static resource
• This site is hosted on IPFS and is compatible with relative URLs, for IPFS and IPNS gateway paths
• The site's resources are served statically, but internal navigation is virtualized: in other words, the site acts as an SPA when browsed on the client
• While a static site, this app can be extended at any time to a full application by changing the target in settings

Stack

• Requires nodeJS and has been tested on node 16
• Uses a Vue framework, nuxtJS, deployed in static mode

Build

To build this site locally

• Clone this repo
• Make sure NodeJS 14 or newer is installed
• To build a static site
  • Run npm ci && npm run generate
  • A directory dist is created, which contains the static site output
• To run locally, for features like hot reload
  • Run npm ci && npm run dev
  • The site will be available in real time via a localhost URL

URLs

• Staging - develop builds to a non public url
• Production - main builds to ffdweb.org
• Each PR will also generate an IPFS build preview link, so it can be validated before being merged

Managing Content

• Areas to edit content
  • Structured content can be found in json files
  • Written paragraph-type content can be found in md files, in markdown format
  • See the content/pages/ directory
  • (As a future step these data structures will be integrated into a CMS)

Components

Example Data Structures for reference

{
  "id": "intro_1",
  "grid": ["middle"],

  "left": {
    "type": "video_block",
    "cols": {
      "num": "col-6",
      "push_left": "off-2"
    },
    "preview_image": "/images/placeholder-image.png",
    "url": "https://www.youtube.com/watch?v=wP4Bk8lBNUc"
  },
  "right": {
    "type": "text_block",
    "layout": "compact",
    "cols": {
      "num": "col-4",
      "push_left": "off-3"
    },
    "label": {
      "type": "D",
      "theme": "light",
      "action": "video",
      "icon": "play",
      "text": "Watch now",
      "url": "https://www.youtube.com/watch?v=wP4Bk8lBNUc"
    },
    "description": "Join us as Thomas Jefferson argues with Alexander Hamilton in Washington D.C.",
    "customizations": [
      {
        "name": "BackgroundLayers",
        "props": {
          "layers-array": [8, 6, 5, 4, 2, 1],
          "offset": 1.375,
          "reverse": true
        }
      }
    ]
  }
}

Common Keys

grid | this is a top-level section key. Any strings in this array will get attached to the grid class.

{
  grid: [String]
}

left, right | these keys contain all the content for the left or right columns. Only 1 is required.

{
  left: Object,
  right: Object
}

cols | this key is nested inside the left or right keys

{
  cols: {
    num: String,
    push_left: String,
    push_right: String
  }
}

Text Block | text_block

{
  type: 'text_block',
  layout: String, // 'large', 'medium' or 'compact'
  label: String|<Button>, // String → simply outputs string | Object → <Button> component is outputted
  heading: String,
  subheading: String,
  description: String,
  ctas: [<Button>]
}

Video Block | video_block

{
  type: 'video_block',
  preview_image: String,
  url: String,
  subtext: <Button>,
  tint: Boolean
}

Image Block | image_block

{
  type: 'image_block',
  src: String
}

Button

{
  type: String, // letter of the alphabet like 'A' or 'B'
  theme: String, // 'light' or 'dark'
  action: String, // 'link', 'nuxt-link', 'button' or 'video'
  icon: String,
  text: String,
  url: String // if action === 'video', this is the URL to the video that opens in the modal
}

Icons

Below is a list of icon values that can be passed into any icon property in the component objects:

• play
• info

FloatingMenu

Below is a list of icon values that can be passed into any icon property in the component objects:

props: {
  id: String, // id of the component instance (optional)
  cutoff: String, // id of an element on the page which when reached will cancel the floating effect (required)
  offsettop: Number, // how far the threshold to enable floating is placed in advance of the viewport top (in pixels) (optional)
  offsetbottom: Number, // how far the threshold to disable floating is placed in advance of the viewport bottom (in pixels) (optional)
  content: String, // inline html to be injected as floating content (optional)
  entries: [ // an array of objects with menu items. The following is an example of the format:
    {
      "heading": "Heading 1",
      "id": "heading-1-id",
      "items": [ // an array of subheadings
        {
          "text": "Subheading 1",
          "id": "subheading-1-id"
        },
        {
          "text": "Subheading 2",
          "id": "subheading-2-id"
        },
        {
          "text": "Subheading 3",
          "id": "subheading-3-id"
        }
      ]
    }
  ]
}