From 937302c902cfa86dcf1926ad574c26c65b1e1c13 Mon Sep 17 00:00:00 2001
From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com>
Date: Tue, 20 Aug 2024 11:05:39 +0900
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs:=20=E3=83=81=E3=83=A5?=
=?UTF-8?q?=E3=83=BC=E3=83=88=E3=83=AA=E3=82=A2=E3=83=AB=E5=86=85=E3=81=AB?=
=?UTF-8?q?npm=20install=E3=81=AE=E6=89=8B=E9=A0=86=E3=82=92=E8=BF=BD?=
=?UTF-8?q?=E5=8A=A0=20#273=20(#278)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* :books: docs: チュートリアル内にnpm installの手順を追加 #273
* 📚 docs: 読みやすさ向上のため細かい表記を修正
---
README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 42 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2addbf7..c527783 100644
--- a/README.md
+++ b/README.md
@@ -171,7 +171,48 @@ GitHub 上でファイルを編集することも可能ですが、
```
cd first-contributions-ja.github.io
```
-- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
+- 次のコマンドで、このプロジェクトに必要なパッケージを、インストールします:
+ ```
+ npm install
+ ```
+
+
+ メモ: npm install とは❓❓
+
+
+
+ **Node.jsがインストールされている状態で、`npm install`コマンドを実行すると、このプロジェクトに必要なライブラリを一括でインストールできます。**
+
+ #### `npm install`した後にできること
+
+ - **ローカルサーバーを起動し、ブラウザでの表示を確認すること**
+ - `npm run dev`コマンド実行後、表示されるURLをクリックすれば確認可能です
+ - **コミット時にコードのチェック・整形を自動で行うこと**
+ - huskyというライブラリを使って実行されます
+ - 自動で実行されるので、何かコマンドを実行したり、作業をする必要はありません
+
+
+
+ `npm install`コマンドについて、より詳しい内容は、[こちら](https://qiita.com/sugurutakahashi12345/items/3cc49926faeaf25d3051)を参照してみて下さい!
+
+ #### 🚧注意) もし、あなたのローカルマシンに、Node.js がインストールされていない場合、`npm install`コマンドで、エラーが発生します。
+
+ その場合、**2通りの対処法**があります。
+
+ - **`npm install`の手順を飛ばす。**
+ - この手順を行わずとも、最低限のコントリビューション体験はできるため、難しい場合は飛ばしていただいてかまいません。
+ - どのくらいの方がここでつまずくか参考までに知りたいので、プルリクエストに「`npm install`がうまくいかなかった」といった報告をしていただけると大変参考になります。
+ - **Node.js をインストールする。**
+ - インストールの手順に関しては、以下のサイトを参照してみて下さい。
+ - [Node.js 公式サイト](https://nodejs.org/en) / [Node.jsインストール方法(macOS) Progate](https://prog-8.com/docs/nodejs-env) / [Node.jsインストール方法(Windows) Progate](https://prog-8.com/docs/nodejs-env-win)
+ - Node.jsについて知りたい場合は [Node.jsとはなにか?なぜみんな使っているのか? Qiita](https://qiita.com/non_cal/items/a8fee0b7ad96e67713eb) を参照してみて下さい。
+ - Web/JavaScript 開発に興味がある場合は、この機会にインストールすることを、おすすめします😎
+
+
+
+
+
+- 次に、プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
- 次のコマンドを使用できます:`git switch -c <ブランチ名>`
- **ブランチ名**は、あなたがこれから行う作業に関連した意味のある名前を付けます。
なので、次のようになります: