1. はじめに:コードを書くだけではもったいない
開発したアプリやツール、ちょっとしたスクリプト。「とりあえず手元に置いておこう」と思ってローカルに眠らせたままになっていませんか?
それ、とてももったいないです。
GitHubに公開することで、
- 他のエンジニアとの知識共有
- ポートフォリオとしての活用
- 他者からのフィードバック
- 転職や副業のチャンスにもつながる
といった多くのメリットがあります。
本記事では、ローカルで作った作品をGitHubにアップロードし、READMEを整備して、世界に発信するまでの一連の流れを実例付きで詳しく解説します。
2. GitHubとは何か?エンジニアのための“作品発信プラットフォーム”
GitHubは、ソースコードのバージョン管理と共同開発を可能にするGitリポジトリのホスティングサービスです。
- Git = 履歴管理の仕組み(ローカル)
- GitHub = それをオンラインで共有できる場所
特に最近は、エンジニアのポートフォリオとしての役割が強く、就職・転職時のアピール材料としても非常に有効です。
3. 実践:ローカルプロジェクトをGitHubにアップロードする手順
今回は以下の簡単なNode.jsのCLIツールを例に説明します。
✅ ステップ1:プロジェクトを用意
mkdir hello-cli
cd hello-cli
npm init -y
touch index.js
// index.js
console.log("Hello, world!");
✅ ステップ2:Gitリポジトリを初期化
git init
git add .
git commit -m "初回コミット"
✅ ステップ3:GitHubで新しいリポジトリを作成
- GitHubにログイン
- 「New Repository」をクリック
- 任意の名前・説明を入力して「Create Repository」
✅ ステップ4:GitHubとローカルを接続
git remote add origin https://github.com/<ユーザー名>/<リポジトリ名>.git
git branch -M main
git push -u origin main
✅ ステップ5:READMEを追加して見栄えを整える
# Hello CLI
シンプルなNode.js CLIツール。`Hello, world!` を出力します。
## 使い方
```bash
node index.js
ライセンス
MIT
---
## 4. よくあるつまずきポイントと実務でのTips
### ❌ pushできない → `main` ブランチが存在しない
```bash
git branch -M main
で解決できます。
❌ remoteが登録されていない
git remote -v
で確認、必要なら
git remote add origin ...
✅ 実務でのポイント
-
.gitignore
を活用してnode_modules
や.env
を除外する - 初期コミットでは README やライセンスファイルも入れておくと印象が良い
-
releases
やtags
を活用すると後で見返しやすい
5. さらに一歩先へ:GitHub PagesやActionsで自動公開
🌐 GitHub PagesでWeb公開
静的サイトなら簡単にホスティングできます。
npm install -g serve
serve .
より本格的に公開するなら、gh-pages
ブランチを使ってデプロイ。
⚙️ GitHub ActionsでCI/CDを組む
テストやデプロイを自動化することで、開発体験が劇的に向上します。
# .github/workflows/nodejs.yml
name: Node.js CI
on:
push:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '18'
- run: npm install
- run: npm test
6. まとめ:GitHubは「見せる」開発の第一歩
✅ メリット
- 作品を可視化できる
- フィードバックがもらえる
- ポートフォリオとして活用可能
⚠️ デメリット
- ソースコードを公開する不安(→
.gitignore
,.env
, ライセンス設定などで対策)
🔮 最後に:次のステップ
このシリーズ「ミニプロジェクト10連発」では、実際に動く小さなアプリやツールを通じて、**“やってみたくなる開発”**を紹介していきます。
次回は「エラー対応マスター」を予定しています。
GitHubにアップしたくなるようなプロジェクトを、一緒に作っていきましょう!