【保存版】GitHubで新しいリポジトリを作る方法|毎回忘れるので黙示録として残す
- 1. はじめに|なぜこの記事を書いたのか
- 2. そもそもGitHubとリポジトリとは?
- 3. Step1|新しいリポジトリ作成画面を開く
- 4. Step2|Repository name(リポジトリ名)を決める
- 5. Step3|Description(説明文)を書く(任意だが推奨)
- 6. Step4|Public / Private を選ぶ
- 7. Step5|READMEを作成する(初心者は必須)
- 8. Step6|.gitignore と License(迷ったらNone)
- 9. Step7|Create repository をクリック
- 10. ここから本番|ローカルのファイルをGitHubにアップする
- 11. 全体の流れ(先に把握する)
- 12. Step8|作業ディレクトリへ移動する
- 13. Step9|Gitを初期化する
- 14. Step10|GitHubリポジトリと紐づける
- 15. Step11|ファイルをステージングする
- 16. Step12|変更を記録する(commit)
- 17. Step13|GitHubへアップロードする(push)
- 18. GitHubで確認する
- 19. VS Codeを使う場合
- 20. よくあるエラー
- 21. まとめ|リポジトリ作成で迷うポイントはここだけ
- 22. おわりに|未来の自分へ
はじめに|なぜこの記事を書いたのか
GitHubで新しいリポジトリを作る。
何度もやっているはずなのに、毎回ちょっと迷う。
- Repository name って何を入れるんだっけ?
- Public / Private はどっち?
- README は最初から必要?
- 作ったあと、どうやってアップするんだっけ?
そんな「毎回のつまずき」を、
未来の自分が二度と迷わないために書き残す黙示録としてまとめました。
この記事は、
- GitHubを触ったことがない人
- GitHubは知っているが毎回手順を忘れる人
- 毎回ググっている過去の自分
に向けて、1から最後(git push)までを順番に解説します。
そもそもGitHubとリポジトリとは?
GitHubとは?
GitHubは、
ソースコードやファイルをインターネット上で管理できるサービスです。
- コードの保存
- 変更履歴の管理
- バックアップ
- 他人との共有
ができます。
リポジトリとは?
リポジトリは、
プロジェクト専用のフォルダのことです。
- 1サイト = 1リポジトリ
- 1案件 = 1リポジトリ
と考えると分かりやすいです。
Step1|新しいリポジトリ作成画面を開く
まず以下のURLにアクセスします。
ログイン済みであれば、
「Create a new repository」 画面が表示されます。
ここがすべての始まりです。
Step2|Repository name(リポジトリ名)を決める
Repository nameとは?
リポジトリ名 = プロジェクト名(フォルダ名)です。
例:
- portfolio
- coding-practice
- shizenno-megumi
ポイント
- 英数字+ハイフンが無難
- URLにも使われる
- 後から変更できるが、最初にちゃんと付けるのがおすすめ
Step3|Description(説明文)を書く(任意だが推奨)
Descriptionは、
このリポジトリが何のためのものかを書く欄です。
例:
- 自然食品サイトのコーディングデータ
- HTML / CSS 学習用
未来の自分を助けるメモになるので、
できるだけ書くのがおすすめです。
Step4|Public / Private を選ぶ
Public
- 誰でも見られる
- ポートフォリオ・学習用におすすめ
Private
- 自分(+許可した人)だけ見られる
- 案件・未公開プロジェクト向け
迷ったら Public で問題ありません。
(後から変更できます)
Step5|READMEを作成する(初心者は必須)
「Add a README file」にチェックを入れます。
README.md は、
このリポジトリの説明書です。
- プロジェクト概要
- 目的
- 使用技術
などを書けます。
初心者は 必ずチェック してください。
Step6|.gitignore と License(迷ったらNone)
.gitignore
GitHubにアップしなくていいファイルを指定する設定です。
- HTML / CSSのみ → None
- Node.js / React → Node
迷ったら None でOK。
License
コードの利用ルールです。
- よく分からなければ None
- オープンにしたいなら MIT License
こちらも後から設定できます。
Step7|Create repository をクリック
入力が終わったら、
Create repository をクリックします。
🎉 これでリポジトリ作成は完了です。
ここから本番|ローカルのファイルをGitHubにアップする
リポジトリは作成できましたが、
まだ中身はGitHubにありません。
ここからは、
自分のPC(ローカル) → GitHub
へファイルをアップロードする手順です。
全体の流れ(先に把握する)
やることはこの順番だけです。
- 作業ディレクトリへ移動
- Gitを初期化
- GitHubリポジトリと紐づけ
- 変更を記録(add / commit)
- GitHubへ送信(push)
Step8|作業ディレクトリへ移動する
ターミナル(またはVS Codeのターミナル)を開き、
GitHubにアップしたいフォルダへ移動します。
cd Desktop/test(こちらは自分の作業ディレクトリー名にしてください。)
中身確認:
ls
アップしたいファイルが表示されていればOKです。
Step9|Gitを初期化する
git init
これで、
このフォルダをGitで管理する状態になります。
Step10|GitHubリポジトリと紐づける
例:
https://github.com/hisa0127/test
git remote add origin https://github.com/hisa0127/test.git
確認:
git remote -v
origin が表示されれば成功です。
Step11|ファイルをステージングする
git add .
. は「このフォルダ内すべて」という意味です。
Step12|変更を記録する(commit)
git commit -m "first commit"
commitは、
セーブポイントを作るイメージです。
Step13|GitHubへアップロードする(push)
初回のみ以下を実行します。
git branch -M main
git push -u origin main
これで、
ローカルのファイルがGitHubに送信されます。
GitHubで確認する
ブラウザでリポジトリページを更新してください。
- ファイルが表示されていれば成功
- GitHubへのアップロード完了です 🎉
VS Codeを使う場合
VS Codeのターミナルでも、
同じコマンドをそのまま使えます。
- Windows:Ctrl + @
- Mac:Cmd + @
よくあるエラー
remote origin already exists
すでに紐づいている場合です。
git remote remove origin
してから再設定します。
まとめ|リポジトリ作成で迷うポイントはここだけ
- https://github.com/new にアクセス
- Repository name を決める
- Public / Private を選ぶ
- README は作成する
- ローカルで git init → add → commit → push
この流れを覚えておけば、
GitHubで二度と迷いません。
おわりに|未来の自分へ
GitHubは難しいのではなく、
最初の手順が少し多いだけです。
この記事にたどり着いた未来の自分は、
今日もちゃんと前に進んでいます。
コメントを残す