filecoin foundation site

Website der Filecoin Foundation

Hinweis: Diese Dokumente werden in einer zukünftigen Version der Website erweitert

Überblick

• Dies ist das Repository für die Website der Filecoin Foundation (fil.org)

• Dieses Repo stellt eine statische Site dar, die kompiliert werden muss, dann aber als statische Ressource bereitgestellt werden kann

• Diese Site wird auf IPFS gehostet und ist mit relativen URLs für IPFS- und IPNS-Gateway-Pfade kompatibel

• Die Ressourcen der Site werden statisch bereitgestellt, die interne Navigation ist jedoch virtualisiert: Mit anderen Worten: Die Site fungiert beim Durchsuchen auf dem Client als SPA

• Obwohl es sich um eine statische Website handelt, kann diese App jederzeit zu einer vollständigen Anwendung erweitert werden, indem das target in den Einstellungen geändert wird

Stapel

• Erfordert nodeJS und wurde auf Knoten 16 getestet
• Verwendet ein Vue-Framework, nuxtJS, das im statischen Modus bereitgestellt wird

Bauen

Um diese Site lokal zu erstellen

• Klonen Sie dieses Repo
• Stellen Sie sicher, dass NodeJS 16 oder neuer installiert ist
• So erstellen Sie eine statische Site
  • Führen Sie npm ci && npm run generate
  • Es wird ein Verzeichnis dist erstellt, das die statische Site-Ausgabe enthält
• Zur lokalen Ausführung für Funktionen wie Hot Reload
  • Führen Sie npm ci && npm run dev
  • Die Site wird in Echtzeit über eine Localhost-URL verfügbar sein
  • Dabei werden Ressourcen zusammengestellt; Beispielsweise werden alle SCSS-Stile in CSS konvertiert und mit Tree-Shake versehen

Struktur

Zu den Schlüsselbereichen dieses Repos gehören:

• /pages – Alle Seitenvorlagen
• /components – Jede wiederverwendbare Sammlung von Elementen wird zu einer Komponente abstrahiert, und die meisten Komponenten akzeptieren verschiedene Eigenschaften, die die Art und Weise ihrer Darstellung bestimmen
• /static – Statische Ressourcen, die nach dem Kompilieren verfügbar sind
• /assets/scss – Die globalen Stile für die App sind hier in SASS/SCSS verfügbar. Spezifischere Stile finden Sie unten auf den .vue -Seiten und -Komponenten (einzelne Dateikomponenten auf vuejs.org).
• /assets/svgs – Enthält Ikonografie oder andere kleine Vektoren im SVG-Format
• /content – ​​Der Inhalt der Website, der mit dem Forestry CMS bearbeitet wird

URLs und Zweige

• Staging – Builds unter a non public url develop
• Produktion – main für fil.org
• Inhalt – content ist ein Zweig, in den das CMS schreibt
  • Wenn ein Pull für main angefordert wird, wird der content durch eine Github-Aktion automatisch genehmigt
• Jeder PR generiert außerdem einen IPFS-Build-Vorschau-Link, sodass er vor der Zusammenführung validiert werden kann

Inhalte verwalten

• Inhalte direkt bearbeiten
  • Strukturierte Inhalte finden sich in json Dateien
  • Geschriebene absatzartige Inhalte finden Sie in md Dateien im Markdown-Format
  • Siehe das Verzeichnis content/pages/
• Bearbeiten von Inhalten über das CMS
  • Der Inhalt kann über Forestry.io bearbeitet werden und erfordert eine Anmeldung
  • Globale Websiteinhalte, wie Standardmetadaten, können im general Abschnitt bearbeitet werden
  • Strukturierter Inhalt wird in Blöcken pro Seite angezeigt (siehe Abschnitt pages ).
  • Blog-Inhalte können in einem Wysiwyg-Markdown-Editor vollständig bearbeitet werden
  • Medien können über den media direkt in das Repository hochgeladen und anschließend in jedem Rich-Media-Bereich verwendet werden