GitHubでのリモートリポジトリ作成からローカルクローンまでの手順と注意点
1. リモートリポジトリの作成
- GitHub公式サイトでリモートリポジトリを作成
- GitHubにログインし、右上の「+」アイコンから「New repository」を選択
- リポジトリ名、説明（オプション）を入力
- 公開設定（Public/Private）を選択
- 「Initialize this repository with a README」のチェックを外す（空のリポジトリを作成するため）
- 「Create repository」をクリック
2. SSHキーの設定
SSHキーは、GitHubとの安全な通信を確立するために必要です。以下の理由から重要です：
- セキュリティ：SSHは強力な暗号化を使用し、通信を保護します。
- 認証：パスワードの代わりに使用され、より安全で便利です。
- 自動化：スクリプトやCIツールでの使用が容易になります。
- アクセス制御：特定のマシンからのみアクセスを許可できます。
SSHキーを設定することで、リポジトリへのセキュアなアクセスと操作が可能になります。
a. SSHキーの生成
ssh-keygen -t ed25519 -C "your_email@example.com"
パスフレーズの入力を求められたら、強力で覚えやすいパスフレーズを使用してください。
(複雑で長い、でも覚えやすいパスフレーズを使用)
b. SSHエージェントの起動
eval "$(ssh-agent -s)"
c. SSHキーをSSHエージェントに追加
ssh-add ~/.ssh/id_ed25519
ここでパスフレーズの入力を求められます。
d. 公開鍵のコピー
cat ~/.ssh/id_ed25519.pub | pbcopy
e. GitHubでSSHキーを追加
- GitHubにログインし、右上のプロフィールアイコンから「Settings」を選択
- 左サイドバーから「SSH and GPG keys」を選択
- 「New SSH key」または「Add SSH key」ボタンをクリック
- 「Title」フィールドにキーの説明を入力（例：「Work Laptop」）
- 「Key」フィールドに公開鍵をペースト
- 「Add SSH key」ボタンをクリックして保存
注意：パスフレーズ（Gravity9%Falls$Universe）は安全に保管し、忘れないようにしてください。このパスフレーズは、SSHキーを使用する際に必要となります。
3. ローカル環境の準備
- ターミナルを開き、プロジェクトを配置したい場所に移動:
cd /path/to/your/projects - 新しいディレクトリを作成し、そこに移動:
mkdir your-project-name cd your-project-name
4. Gitの初期化
- ローカルディレクトリをGitリポジトリとして設定するために必要
- これにより、バージョン管理機能が有効になり、変更の追跡や履歴の管理が可能になる
git init
このコマンドは、現在のディレクトリを新しいGitリポジトリとして初期化します。
5. リモートリポジトリの追加
git remote add origin git@github.com:username/repository.git
このコマンドは、ローカルリポジトリにリモートリポジトリへの参照を追加します。'origin'は通常使用されるリモートの名前で、URLはGitHubリポジトリのSSH URLです。
6. 初期コミットの作成（オプション）
a. 空のリポジトリの場合：
echo "# My Project" > README.md
git add README.md
git commit -m "Initial commit"
これらのコマンドは、README.mdファイルを作成し、Gitのステージングエリアに追加し、初期コミットを作成します。
b. ローカルにファイルディレクトリ構成を作成した場合：
# ディレクトリ構造を作成
mkdir -p src/{components,pages,styles}
touch src/components/.gitkeep src/pages/.gitkeep src/styles/globals.css
echo "# My Project" > README.md
# 全てのファイルをステージングエリアに追加
git add .
# 初期コミットを作成
git commit -m "Initial project structure"
これらのコマンドは、基本的なプロジェクト構造を作成し、全てのファイルをステージングエリアに追加して初期コミットを作成します。
初期コミットが必要な理由：
- リポジトリの歴史の起点を作成します。これにより、プロジェクトの開始点が明確になります。
- 空のリポジトリにブランチを作成することができます。Gitは空のリポジトリにブランチを作成できないため、初期コミットが必要です。
- プロジェクトの基本的な構造や説明を含むREADME.mdを追加することで、他の開発者がプロジェクトを理解しやすくなります。
- ローカルでファイル構造を作成した場合、初期のプロジェクト構造をバージョン管理下に置くことができます。
7. リモートリポジトリへのプッシュ
git push -u origin main
このコマンドは、ローカルの'main'ブランチをリモートの'origin'リポジトリにプッシュします。'-u'オプションは、今後のプッシュとプルのデフォルトを設定します。
注意: 既存のファイルがある場合は、手順3の後にそれらのファイルをディレクトリにコピーし、手順5でそれらをステージングし、コミットしてください。
付録
- GitHub Codespaceはオフラインや接続不安定時には使えないため、個人開発では利用を見送ったほうがいいかもしれません。