ことれいのもり

VSCodeとGitコマンドでGitHubにプロジェクトをアップロードする方法

はじめに

この記事では、ローカル環境で作ったプロジェクトを、GitHubにアップロードするために、Gitコマンドを使ってGitHubに送信する方法を解説します。

画像を多めに使って、初心者の人でも迷わず進められるよう丁寧に説明していきます。


この手順を整理しておくことで、今後Gitを使った操作も迷わなくなると思ってまとめました。

丁寧に書いておけばきっと未来の自分に役立つと思ってます!


記事を分けており、前回の記事でGitHub上でリポジトリを作成する方法を解説しました。

前回の記事を見ていない方はぜひご覧ください。

GitHubで新しいリポジトリを作成する方法

前提

環境と使った物

Gitコマンドで操作する

VSCode側でGitコマンドを使って操作していきます。

1.VSCodeでターミナルを開く

VSCodeでプロジェクトを作るフォルダを開き、ターミナルを表示します。

ターミナルは「Ctrl + `(バッククォート)」キーのショートカットで表示することができます。


VSCodeターミナル


赤枠で囲ったところがターミナルです。

ここにコマンドを入力して操作をします。

2. GitHubに上げたいフォルダに移動する

Gitコマンドは、リポジトリのルート(.gitフォルダがある場所)で実行する必要があります。

つまり、GitHubにアップロードしたいプロジェクトのルートフォルダにターミナルで移動する必要があります。


移動は cd というコマンドを使います。

cd フォルダ名


例えば、フォルダ名が「Sample」なら、

cd Sample


これで遷移できます。
私の環境では、「Arknights」フォルダの中にある Laravel プロジェクト「ArknightsBaseOptimizer」がプロジェクトルートです。


プロジェクト構成


つまり、GitHubにアップロードしたいフォルダは「ArknightsBaseOptimizer」なので、そこまで移動する必要があります。
その場合は、次のように入力します。

cd ArknightsBaseOptimizer


cdコマンド


これでターミナルのルートがプロジェクトルートに変更されました!


※ 注意 フォルダ構成によっては、既にVSCodeでプロジェクトルートを開いていれば、移動不要の場合があります。

3. git init コマンドでローカルリポジトリを作成する

次に、ローカルリポジトリを作成します。

「ローカルリポジトリ」とは、あなたのパソコンの中にGitの管理データを置く場所のことです。

この操作をすると、プロジェクトがGitでバージョン管理できる状態になります。


コマンドは簡単です。

git init


実行すると、自動的に処理が走り、フォルダ内に .git という隠しフォルダが作成されます。


git initコマンド


これで、プロジェクトをGit管理する準備が整いました!


補足:リポジトリはGitHubで作成しなかった?

「リポジトリを作るのはGitHubでやったのに、またリポジトリを作るの?」と思ったかもしれません。

ここで作ったのは、ローカルリポジトリ (自分のパソコン上のGit管理データ)です。

一方、GitHubで作成したものはリモートリポジトリと呼ばれるものです。


  • ローカルリポジトリ:自分のパソコン上で管理する
  • リモートリポジトリ:GitHub上で管理する


このあとで、「ローカル」と「リモート」をつなげて、コードをGitHubにアップロードできるようにします。

4. git add コマンドでステージングする

次に、ステージングと呼ばれる作業をします。

ステージングとは、「どのファイルを保存対象にするか選ぶ作業」です。


コマンドは、次の通りです。

git add .


「.」は「全ての変更を対象にする」という意味です。 実行すると、変更されたファイルが全てステージングされます。

5. git commit コマンドでコミットする

次に、コミットをします。

コミットとは、「ステージングされた変更を、履歴として保存すること」 です。

「ゲームのセーブポイントを作る」みたいなものです。


コマンドは、次の通りです。

git commit


実行すると、自動的にエディタが開いて、コミットメッセージを入力する画面になります。 この「コミットメッセージ」では、何を変更したかを簡単に書くことができます。


git commitで開かれる画面


今回は初回コミットなので、「初回コミット」と入力すればOKです。(もちろん他の文字列でも大丈夫です)

Initial commit


こんなかんじです。


コミットメッセージ


これで、ローカルリポジトリ(自分のパソコン上)に最初の履歴が保存されました!

6. git remote コマンドでGitHubとつなげる

次に、GitHubのリモートリポジトリと、自分のパソコン上のローカルリポジトリを紐付けます。

これをしないと、ローカルでコミットした内容をGitHubに送れません。


コマンドは、次の通りです。

git remote add origin GitHubのURL


ここで「GitHubのURL」には、GitHubで作成したページにある「HTTPS」や「SSH」のURLをコピーして貼り付けます。(例: https://github.com/ユーザー名/リポジトリ名.git


画像で説明すると、赤枠がGitHubのURL、青枠のボタンを押すとコピーできます。

コピーした物をコマンドの最後に貼り付けましょう。


GitHubでURLをコピーする画面


このコマンドを実行しても画面上は特に変化しません。


git remoteコマンド


実行できているかの確認は、次のステップで行ないますので安心してください。

originとは?

「origin」は、リモートリポジトリにつけるニックネームです。

URLを毎回入力するのは大変なので、originという別名で登録しておきます。

一般的にoriginと名付けますが、好きな名前をつけても大丈夫です。


例えば、次のように使えます。

git push origin main
git pull origin main

この場合、originと書くだけで内部的にはGitHubのURLを参照して動作してくれます。

7. git remote -v コマンドで紐付いているか確認する

さきほどのコマンドは画面上で変化がなかったので、正しく登録できているかを確認してみましょう。


git remote -v


このコマンドを実行すると、紐付いているGitHubのリポジトリURLが出力されます。

私の環境では以下のように表示されました。


git remote -v コマンド


(fetch)は「取得(ダウンロード用)」、(push)は「送信(アップロード用)」のURLです。

どちらも表示されていれば、GitHubとローカルリポジトリの紐付けは完了です!

8. git push コマンドでGitHubに送信する

最後に、GitHubにコードを送信します。 この操作を、pushと呼びます。


コマンドは次の通りです。

git push origin main


ここのコマンドの内容は次のような意味です。

  • origin → 先ほど登録したリモートリポジトリ(GitHub)のニックネーム
  • main → 今作業しているブランチの名前(Laravelプロジェクトを新規作成した場合はmainがデフォルト) つまり、「現在のmainブランチをGitHubのoriginに送る」という意味になります。


実行すると、私の環境では以下のように表示されました


git push コマンド


これで、GitHubにデータが送信されました!

実際にGitHubのリポジトリページを開いてみましょう。


アップロード後のGitHub画面


このようにファイルが表示されていれば、無事にアップロード成功です!

おわりに

今回は、VSCodeのターミナルを使って、Gitコマンドを入力しながらGitHubに送信する方法を解説しました。

前回の記事と合わせて、プロジェクト作成~GitHubとの連携まで一通りできるようになったと思います。

自分自身への備忘録として作成しましたが、誰かの参考になれば幸いです。