Skip to content

Commit

Permalink
docs: READMEの更新
Browse files Browse the repository at this point in the history
  • Loading branch information
shun-shobon committed Jan 9, 2024
1 parent 6e75309 commit 0c8c061
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,24 @@ pnpm install
pnpm dev
```

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

### ビルド

```shell
pnpm build
```

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

### ビルド成果物の確認

```shell
pnpm start
```

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

### 型チェックの実行

```shell
Expand All @@ -71,3 +77,20 @@ pnpm format
```

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

## Deployment

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

## Continuous Integration

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

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

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

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

0 comments on commit 0c8c061

Please sign in to comment.