本記事で取り扱う事
- GitHubを用いてWeb上に自分のコードを取り敢えず公開する方法
「取り敢えず」ってのががミソです。
誰かにコード見てもらいたいと思ったものの、いざGitHubについて調べると、なんか色々長ったらしい説明が出てきて読むのに疲れて諦めてしまった人が周りにいたので書きました。
所以、詳しい説明は本記事では取り扱わないので悪しからず。
一回使えるようになってしまえば説明に対するハードルも下がるので、詳しい説明をされている方々の記事も読めるようになるかと。。。。
前提・対象
- Gitのダウンロードが済んでいる
- GitHubの登録が済んでいる(まだの人は下から登録)
- とりあえずGitHubに公開したい人
Web上に公開する。つまり不特定多数の人が閲覧可能な状態だという事を常に念頭に置いてください。
メールアドレスなどの個人情報を直接記載することは控え、APIキーなどは適宜環境変数や設定ファイルに記載することを推奨します。
公開鍵・秘密鍵の発行
まず初めにGitHubと自身のPCを紐づける公開鍵、秘密鍵を発行します
macの方はこちら
$mkdir .ssh
$cd .ssh
$ssh-keygen -t rsa -C '自分のメールアドレス'
//色々聞かれるが何も入力せずEnterを数回入力
$cat id_rsa.pub
windowsの方はこちら
$mkdir .ssh
$cd .ssh
$ssh-keygen -t rsa -C '自分のメールアドレス'
//色々聞かれるが何も入力せずEnterを数回入力
$type "id_rsa.pub"
最後に以下の様な超長い文字列が出力されると思います。
ssh-rsa AAAAB3NzaC1yc2EAAA..............................................
これをssh-rsaの部分から最後までコピーしておいてください!
発行した公開鍵の登録
以下のURLにアクセスしてください。
https://github.com/settings/ssh/new
写真の様な画面になると思います。
Title欄→分かりやすい任意の文字列(登録日とか)
Keytype→Authentication Key
Key欄→先ほどコピーした超長い文字列
を入力し、Add SSH key
を押して登録してください。
GitHubレポジトリの作成
以下のURLにアクセスしてください
どこかしらのNew
という緑色のボタンを押して頂いても大丈夫です。
https://github.com/new
写真のような画面になると思います。
Repository name
欄にご自身のプロダクトの名前を設定してください。
※英数字のみ、分かりやすい名前推奨
それ以外は何もいじらず右下にある緑のCreate repository
を押下
すると以下の様な画面になるかと思います。
緑で囲っている部分をSSH
に変更し、赤枠で囲っている部分をコピーしておいてください。
コマンド入力
ご自身のユーザー名とメアドを登録してください。
git config --global user.name "ユーザー名"
git config --global user.email "メールアドレス"
ここからは、ご自身のプロダクトの階層で行ってください。
以下の順に入力してください。
$git add .
$git commit -m "first commit"
$git remote add origin さきほど赤枠内でコピーした内容
$git push origin master
macの場合はデフォルトがmainブランチの場合があるのでその場合はgit push origin main
と打ちましょう
GitHubに戻り、Repositories
の欄に作成したレポジトリ名があれば成功です。(写真でいうexample)
コードを共有する場合はご自身のレポジトリ名にアクセスし、その際のURL:https://github.com/ご自身のユーザー名/レポジトリ名
を共有しましょう。
プロダクトを編集してGitHubのレポジトリも更新したい時
ご自身のプロダクトが改良されるなどして、最新の状態のコードを公開したいときは以下の順にコマンドを入力してください。
git add .
git commit -m "変更内容をメモ"
git push origin master
記事自体は以上です。お疲れ様でした。
紹介
今回は個人のプロダクトをただ公開する事のみに焦点を当てましたが、Git・GitHubを使うとコードを元に戻したり、チームで開発出来たりします。
もっと詳しく公開鍵やGitHubについて知りたい人向けに