GitHub入門|はじめてのリポジトリ作成と公開
GitHubは、Gitで管理しているコードをインターネット上に保存・公開できるサービスです。世界中の開発者が利用しており、チーム開発やオープンソースプロジェクトの中心的なプラットフォームとなっています。この記事では、GitHubアカウントの作成からコードの公開までの手順を解説します。
GitHubアカウントの作成
GitHubの公式サイト(https://github.com/)にアクセスし、「Sign up」からアカウントを作成します。
必要な情報は以下の3つです。
- メールアドレス
- パスワード
- ユーザー名(公開されるのでわかりやすいものにしましょう)
無料プランでも、公開リポジトリ・非公開リポジトリともに無制限に作成できます。
リポジトリの作成
GitHub上で新しいリポジトリを作成
- GitHubにログインし、右上の「+」から「New repository」を選択
- リポジトリ名を入力(例:
my-first-project) - 説明を入力(任意)
- 「Public」(公開)または「Private」(非公開)を選択
- 「Create repository」をクリック
ローカルのプロジェクトとリモートを接続
リポジトリを作成すると、セットアップ手順が表示されます。
# ケース1: 新しいプロジェクトを始める場合
mkdir my-first-project
cd my-first-project
git init
echo "# My First Project" > README.md
git add README.md
git commit -m "最初のコミット"
git branch -M main
git remote add origin https://github.com/ユーザー名/my-first-project.git
git push -u origin main
# ケース2: 既存のローカルリポジトリを接続する場合
cd existing-project
git remote add origin https://github.com/ユーザー名/my-first-project.git
git branch -M main
git push -u origin main
各コマンドの意味を説明します。
git branch -M main: メインブランチの名前をmainにするgit remote add origin URL: リモートリポジトリの接続先を設定するgit push -u origin main: ローカルの変更をGitHubに送信する
日常的なワークフロー
コードを変更してGitHubに反映する
# 1. ファイルを編集する(エディタで作業)
# 2. 変更を確認
git status
# 3. 変更をステージしてコミット
git add .
git commit -m "ナビゲーションメニューを追加"
# 4. GitHubにプッシュ
git push
# 初回以降は git push だけでOK
# (-u origin main は初回のみ必要)
GitHubから最新のコードを取得する
複数の端末で作業している場合や、チームで開発している場合は、GitHubから最新のコードを取得する必要があります。
# リモートの変更をローカルに取り込む
git pull
# 出力例:
# remote: Enumerating objects: 5, done.
# Updating a1b2c3d..d4e5f6a
# Fast-forward
# index.html | 10 ++++++++++
# 1 file changed, 10 insertions(+)
SSH認証の設定
HTTPS接続ではプッシュのたびに認証が必要になることがあります。SSHキーを設定すると、パスワード入力なしでGitHubと通信できるようになります。
# SSHキーを生成
ssh-keygen -t ed25519 -C "[email protected]"
# Enterを押して進む(パスフレーズは任意)
# 生成された公開鍵を表示
cat ~/.ssh/id_ed25519.pub
# ssh-ed25519 AAAA...(この文字列をコピー)
コピーした公開鍵をGitHubに登録します。
- GitHubの「Settings」を開く
- 「SSH and GPG keys」を選択
- 「New SSH key」をクリック
- タイトルを入力し、公開鍵を貼り付けて保存
# SSH接続の確認
ssh -T [email protected]
# Hi ユーザー名! You've successfully authenticated
# SSHのURLでリモートを設定
git remote set-url origin [email protected]:ユーザー名/my-first-project.git
READMEとgitignore
README.md
README.mdはプロジェクトの説明文です。GitHubのリポジトリページに自動的に表示されます。
# プロジェクト名
プロジェクトの簡単な説明を書きます。
## 使い方
1. リポジトリをクローンする
2. 依存パッケージをインストールする
3. 開発サーバーを起動する
## 技術スタック
- HTML / CSS
- JavaScript
.gitignore
Gitの管理対象外にするファイルを指定します。
# .gitignore の例
# OS固有のファイル
.DS_Store
Thumbs.db
# 依存パッケージ
node_modules/
# 環境変数・機密情報
.env
.env.local
# ビルド成果物
dist/
build/
# エディタの設定
.vscode/settings.json
*.swp
.gitignoreはプロジェクトの最初に作成しておきましょう。あとから追加しても、すでにコミットしたファイルは除外されないため注意が必要です。
よくある間違いと対策
間違い1: pushが拒否される
git push
# error: failed to push some refs to 'origin'
# hint: Updates were rejected because the remote contains work that you do not have locally.
これはリモートにローカルにない変更がある場合に発生します。
# 先にpullしてからpushする
git pull
git push
間違い2: 認証エラー
git push
# remote: Permission to user/repo.git denied
認証情報が正しく設定されていない可能性があります。SSH認証を設定するか、Personal Access Tokenを使いましょう。
間違い3: 機密情報をプッシュしてしまった
# パスワードやAPIキーをプッシュしてしまった場合
# 一度公開された情報は取り消せないと考える
# 以下を行う:
# 1. すぐにパスワード・APIキーを変更する
# 2. .gitignoreに機密ファイルを追加する
# 3. 今後は.envファイルなどを使い、.gitignoreで除外する
機密情報は一度GitHubにプッシュすると、コミットを削除しても履歴に残ります。プッシュ前に必ずgit diff --stagedで内容を確認しましょう。
GitHubはコードの管理だけでなく、ポートフォリオとしても活用できます。学習したコードを積極的にプッシュして、自分の成長記録を残していきましょう。