Skip to content

Commit

Permalink
📚 docs: チュートリアル内にnpm installの手順を追加 #273 (#278)
Browse files Browse the repository at this point in the history
* 📚 docs: チュートリアル内にnpm installの手順を追加 #273

* 📚 docs: 読みやすさ向上のため細かい表記を修正
  • Loading branch information
kazzyfrog authored Aug 20, 2024
1 parent 7dc4b99 commit 937302c
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,48 @@ GitHub 上でファイルを編集することも可能ですが、<br>
```
cd first-contributions-ja.github.io
```
- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
- 次のコマンドで、このプロジェクトに必要なパッケージを、インストールします:
```
npm install
```
<br>
<details>
<summary>メモ: npm install とは❓❓</summary>

<br>

**Node.jsがインストールされている状態で、`npm install`コマンドを実行すると、このプロジェクトに必要なライブラリを一括でインストールできます。**

#### `npm install`した後にできること

- **ローカルサーバーを起動し、ブラウザでの表示を確認すること**
- `npm run dev`コマンド実行後、表示されるURLをクリックすれば確認可能です
- **コミット時にコードのチェック・整形を自動で行うこと**
- huskyというライブラリを使って実行されます
- 自動で実行されるので、何かコマンドを実行したり、作業をする必要はありません

<br>

`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 開発に興味がある場合は、この機会にインストールすることを、おすすめします😎

</details>

<br>

- 次に、プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
- 次のコマンドを使用できます:`git switch -c <ブランチ名>`
- **ブランチ名**は、あなたがこれから行う作業に関連した意味のある名前を付けます。
なので、次のようになります:
Expand Down

0 comments on commit 937302c

Please sign in to comment.