filecoin foundation site

ファイルコイン財団ウェブサイト

注: これらのドキュメントは、サイトの今後の反復で拡張される予定です。

概要

• これは、 Filecoin Foundation Web サイト (fil.org) のリポジトリです。

• このリポジトリは、コンパイルが必要な静的サイトを表しますが、静的リソースとして提供できます。

• このサイトは IPFS でホストされており、IPFS および IPNS ゲートウェイ パスの相対 URL と互換性があります。

• サイトのリソースは静的に提供されますが、内部ナビゲーションは仮想化されます。つまり、サイトはクライアントで閲覧されるときに SPA として機能します。

• このアプリは静的サイトですが、設定でtarget変更することで、いつでも完全なアプリケーションに拡張できます。

スタック

• nodeJS が必要で、ノード 16 でテストされています
• 静的モードでデプロイされた Vue フレームワーク nuxtJS を使用します

建てる

このサイトをローカルに構築するには

• このリポジトリのクローンを作成します
• NodeJS 16 以降がインストールされていることを確認してください
• 静的サイトを構築するには
  • npm ci && npm run generate実行します
  • distディレクトリが作成され、静的サイトの出力が含まれます。
• ホットリロードなどの機能をローカルで実行するには
  • npm ci && npm run dev実行します
  • サイトはローカルホスト URL 経由でリアルタイムで利用可能になります
  • リソースはこのプロセスでコンパイルされます。たとえば、すべての SCSS スタイルは CSS に変換され、ツリーシェークされます。

構造

このリポジトリの主な領域は次のとおりです。

• /pages - すべてのページ テンプレート
• /components - 再利用可能な要素の各コレクションはコンポーネントに抽象化され、ほとんどのコンポーネントはレンダリング方法を決定するさまざまなプロパティを受け入れます。
• /static - コンパイル後に使用できる静的リソース
• /assets/scss - アプリのグローバル スタイルは SASS/SCSS で入手できます。より具体的なスタイルは.vueページとコンポーネント (vuejs.org の単一ファイル コンポーネント) の下部にあります。
• /assets/svgs - SVG 形式のアイコンまたはその他の小さなベクトルが含まれています
• /content - 林業 CMS を使用して編集されたサイトのコンテンツ

URLとブランチ

• ステージング - a non public urlにビルドdevelop
• 実稼働 - fil.orgへのmainビルド
• コンテンツ - content CMS が書き込むブランチです
  • mainに対してプルリクエストが行われると、 contentブランチは Github アクションによって自動的に承認されます
• 各 PR は IPFS ビルド プレビュー リンクも生成するため、マージ前に検証できます。

コンテンツの管理

• コンテンツを直接編集する
  • 構造化コンテンツはjsonファイルで見つけることができます
  • 書かれた段落タイプのコンテンツは、マークダウン形式のmdファイルにあります。
  • content/pages/ディレクトリを参照してください。
• CMS経由でコンテンツを編集する
  • コンテンツはForestry.io経由で編集でき、ログインが必要です
  • デフォルトのメタデータなどのグローバル サイト コンテンツは、 generalセクションで編集可能です
  • 構造化コンテンツはページごとにブロックで表示されます ( pagesセクションを参照)
  • ブログのコンテンツは wysiwyg マークダウン エディターで完全に編集可能です
  • メディアはmediaセクションを介してリポジトリに直接アップロードでき、その後はあらゆるリッチ メディア フィールドで使用できるようになります。