jo-ken.info

情報技術研究部の公式サイト

About

情報技術研究部の公式サイトのリポジトリです。

Features

• Astro
• TypeScript
• Tailwind CSS
• ESLint
  • @shun-shobon/eslint-config による包括的な設定が含まれています。
• Prettier
  • @shun-shobon/prettier-config による包括的な設定が含まれています。
• GitHub Actions

Requirements

• Node.js
  • バージョンは.nvmrcで管理しています。Node.jsをインストールする際はnvmやasdfなどを用いてください。
• pnpm
  • バージョンはpackage.jsonのpackageManagerという項目で管理しています。corepackを用いるとこの項目を参照して自動的にバージョンを切り替えてくれるため、corepackを使用することをおすすめします。

Commands

インストール

pnpm install

開発サーバーの起動

pnpm dev

http://localhost:4321/ で開発サーバーが起動します。ホットリロード対応なので、ソースコードを編集すると自動的に再更新されます。

ビルド

pnpm build

dist/にビルド結果が出力されます。これが本番サーバーにデプロイされます。

ビルド成果物の確認

pnpm start

dist/の中身を確認することができます。

型チェックの実行

pnpm type-check

リンタの実行

pnpm lint

lint:fixで自動修正を行うこともできます。

フォーマッタの実行

pnpm format

format:checkで自動修正無しの実行を行うこともできます。

Deployment

デプロイはGitHub Actionsによって自動的に行われます。 masterブランチにpushされると、自動的にビルドが行われ、GitHub Pagesにデプロイされます。

Continuous Integration

リモートにpushされると、GitHub Acgtionsによって以下の処理が自動的に行われます。

• 型チェック+リンタ+フォーマットの実行
• ビルド

これによって、コードが常に動作することを保証しています。

また、Depndabotによって依存パッケージのアップデートが自動的に行われます。 ただし、メジャーバージョンは手動でのアップデートが必要です。また、CIが失敗した場合はPRがmergeされないため、手動での修正が必要です。