From 35613050df7d48af7c03edcfe729bd16b9404b7f Mon Sep 17 00:00:00 2001 From: masataka Date: Mon, 1 Jul 2024 22:06:37 +0900 Subject: [PATCH] =?UTF-8?q?README=E3=82=92=E6=9C=80=E6=96=B0=E4=BA=8B?= =?UTF-8?q?=E6=83=85=E3=81=AB=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d32d074..79b15a6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ # 企業WEBサイト -クリップクロウ合同会社の企業WEBサイト。製品の紹介を中心におこないつつ、会社案内としてコンサルテーションやSIの事業についても言及する。 +クリップクロウ合同会社の企業WEBサイト。会社案内としてコンサルテーションやSIの事業について言及し、 +Essential Workwareに関するページでは製品のカラー設計でデザインされている。 SSGとDevOps/CDを利用して、リポジトリにコンテンツをプッシュすると公開先クラウドに自動で展開させる。 ## /(root) @@ -22,41 +23,48 @@ SSGとDevOps/CDを利用して、リポジトリにコンテンツをプッシ お問い合わせSPAからの送信は、serve.ts で受診している。以下の設定を行う。 - .envファイルを用意して、"SLACK_WEBHOOK_URL"キーにSlack Webhook URLを記載する。 -- Deno Deployには＝も、同上のキーを用意する。 +- Deno Deployに、同上のキーを用意する。 ローカルでSlackポストをテストする場合は、deno task serveではserve.tsを用いないため、以下を実行する。 ```sh -% deno run -A serve.ts +% deno run -A --unstable-kv serve.ts ``` ### /src サイトのコンテンツが格納されている。テンプレートにはReactを.tsxで利用している。 -/src/_data フォルダには、サイトを構成する情報が格納されている。 - -- careers.yml: 経歴のデータ -- features.yml: 特長・機能のデータ -- usages.yml: 解決する課題のデータ - -/src/scss フォルダにはSASSファイルが格納されている。Lumeによってビルドされる。 +- 最新情報のメンテナンス + - /src/information/_data/information.yml を編集する +- 代表社員経歴のメンテナンス + - /src/leadership/_data/careers.yml を編集する ### /contact お問い合わせの機能を提供するSPA。 - ローカル環境にプルした後、contactフォルダに移動して、npm installを実行 -- npm run build を実行すると、/src/contact にSPAを出力する -- お問い合わせを操作すると、"/slack" - へ入力内容を送信する。serve.tsで受診して処理を行う +- npm run build を実行すると、/src/contact/js にSPAを出力する +- お問い合わせを操作すると、"/slack"へ入力内容を送信する。serve.tsで受信して処理を行う + +### /api + +APIドキュメントを提供するSPA。 + +- ローカル環境にプルした後、apiフォルダに移動して、npm installを実行 +- npm run build を実行すると、/src/product/api/js にSPAを出力する +- 画面上のReDoc Reactコンポーネントでドキュメントを生成する。 +- APIドキュメントの元となるJSONは、/api/docs.json をserve.ts経由でapi.ewware.comより取得する + ### /.github/workflows GitHub Actionで、リポジトリへのプッシュがあったときにDeno Deployへ自動配置するようにしている。 - GitHub Action の Dockerコンテナ上に、ソースコードをクローンする。 -- Node.js 環境を自動構築して /contact のお問い合わせReactアプリをコンパイルする。コンパイルした成果物は、/src/contact に出力する。 +- Node.js 環境を自動構築して /contact のお問い合わせReactアプリをコンパイルする。 +- Node.js 環境を自動構築して /api のAPIドキュメントReactアプリをコンパイルする。 - Dockerコンテナ上で Lume を自動実行する。このタイミングでWEBサイト構成物が生成される。 - denoland/deployctl プラグインを利用して、すべてのWEBサイト構成物をDeno Deployにアップロードする。