Skip to content

Commit c407fbf

Browse files
committed
update readme
1 parent 34ff4ee commit c407fbf

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ https://my-code.utcode.net
44

55
## インストール
66

7+
Node.js に加えて [pnpm 11](https://pnpm.io/ja/installation) をインストールしてください。
8+
79
```bash
8-
npm ci
10+
pnpm install --frozen-lockfile
911
```
1012

1113
## 開発環境
1214

1315
```bash
14-
npx prisma dev
16+
pnpm exec prisma dev
1517
```
1618
を実行し、`t` キーを押して表示される DATABASE_URL をコピー
1719

@@ -44,37 +46,37 @@ SENTRY_DSN=
4446

4547
別のターミナルで、
4648
```bash
47-
npm run db-migrate
49+
pnpm run db-migrate
4850
```
4951
でデータベースを初期化
5052

5153
```bash
52-
npm run db-docs
54+
pnpm run db-docs
5355
```
5456
でデータベースにドキュメントのページ情報を挿入します。
5557
(public/docs/以下にmarkdownを追加・削除したら再度実行する必要があります)
5658

5759
```bash
58-
npm run dev
60+
pnpm run dev
5961
```
6062
[http://localhost:3000](http://localhost:3000) で開きます。
6163

6264
```bash
63-
npm run format
65+
pnpm run format
6466
```
6567
でコードを整形します。
6668

6769
```bash
68-
npm run lint
70+
pnpm run lint
6971
```
7072
でコードをチェックします。出てくるwarningやerrorはできるだけ直しましょう。
7173

7274
### データベースのスキーマ
7375

74-
* データベースのスキーマ(./app/schema/hoge.ts)を編集した場合、 `npm run db-generate` (`npx drizzle-kit generate`) でmigrationファイルを作成し、 `npm run db-migrate` (`npx drizzle-kit migrate`) でデータベースに反映します。
76+
* データベースのスキーマ(./app/schema/hoge.ts)を編集した場合、 `pnpm run db-generate` (`pnpm exec drizzle-kit generate`) でmigrationファイルを作成し、 `pnpm run db-migrate` (`pnpm exec drizzle-kit migrate`) でデータベースに反映します。
7577
* 本番環境のデータベースのmigrateはmainにpushされた際にGitHub Actionで実行されます
7678
* スキーマのファイルを追加した場合は app/lib/drizzle.ts でimportを追加する必要があります(たぶん)
77-
* `npx prisma dev` で立ち上げたデータベースは `npx prisma dev ls` でデータベース名の確認・ `npx prisma dev rm default` で削除ができるらしい
79+
* `pnpm exec prisma dev` で立ち上げたデータベースは `pnpm exec prisma dev ls` でデータベース名の確認・ `pnpm exec prisma dev rm default` で削除ができるらしい
7880

7981
### 本番環境の場合
8082

@@ -136,7 +138,7 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
136138
* REPLのコード例は1セクションに最大1つまで。
137139
* コードエディターとコード実行ブロックはいくつでも置けます。
138140
* ページ0以外の各ページの最後はレベル2見出し「この章のまとめ」と、レベル3見出し「練習問題n」を置く
139-
* 編集したドキュメントにローカルの開発環境でアクセスする際は `npm run db-docs` を実行してください。これにより `public/docs/revisions-dev.yml` が更新・作成され、チャットが正しく動作するようになります。
141+
* 編集したドキュメントにローカルの開発環境でアクセスする際は `pnpm run db-docs` を実行してください。これにより `public/docs/revisions-dev.yml` が更新・作成され、チャットが正しく動作するようになります。
140142
* 本番環境用の `revisions.yml` は、main ブランチに push された際に GitHub Action によって自動的に更新されます。
141143

142144
### ベースとなるドキュメントの作り方

0 commit comments

Comments
 (0)