こんにちは、今回は初めて GitHub でプロジェクト管理を始める初心者プログラマーに向けて、仮想環境の構築からリポジトリの作成、GitHub へのプッシュまでの一連の手順を説明します。具体例として Python 3.12 と Flask を使用していますが、この手順は他のプログラミング言語やフレームワークにも応用できます。これにより、プロジェクトのバージョン管理が容易になり、チームメンバーと協力しやすくなります。

この記事は 2024-5-27に「T.Miyakaw Blog https://miyakawa2449.github.io/」で公開した記事を写しています。

前提条件

• git がインストールされていること
• GitHub アカウントを持っていること
• Python 3.12 がインストールされていること

プロジェクトディレクトリの作成

まず、プロジェクト用のディレクトリを作成し、そのディレクトリに移動します。

`mkdir my-new-projectcd my-new-project`

git の初期化

次に、git を初期化します。これにより、新しいリポジトリが作成され、プロジェクトの変更を追跡できるようになります。

`git init`

仮想環境の構築

仮想環境を構築し、アクティブにします。以下のコマンドは Unix 系 (Linux, macOS) の場合です。

`python3.12 -m venv venvsource venv/bin/activate`

Windows の場合は以下のように仮想環境を構築し、アクティブにします。

python -m venv venv
venv\Scripts\activate

<strong>注意:</strong> ここでは venv で仮想環境を構築しましたが、Docker 環境を使用することもできます。また、最悪仮想環境が無くてもプロジェクトを進めることは可能です。ただし、仮想環境や Docker を使用することで、依存関係の管理がしやすくなりますので、可能であれば使用することをお勧めします。<br></br><br></br>今回は Python を例に取り上げましたが、同様の手順は他の言語でも適用できます。例えば、PHP や Ruby on Rails などのプロジェクトでも、仮想環境や Docker を使用して依存関係を管理することが推奨されます。言語やフレームワークに関わらず、プロジェクトのセットアップと管理は、適切なツールと手順を用いることでより効率的に行うことができます。

Flask のインストール

仮想環境内に Flask をインストールします。

`pip install Flask`

シンプルな Flask アプリの作成

ここで作成する Flask アプリは非常にシンプルなものです。この内容は Python に限らず、他の言語やフレームワークでも同様の手順でプロジェクトを進めることができます。Flask を使わない場合でも、このステップはあなたのプロジェクトに応じて適切に置き換えることができます。

以下の内容で app.py ファイルを作成します。

`from flask import Flaskapp = Flask(__name__)@app.route('/')def hello():    return 'Hello, World!'if __name__ == '__main__':    app.run()`

このコードはシンプルな Flask アプリを定義しています。http://127.0.0.1:5000 にアクセスすると、Hello, World! と表示されるはずです。

Flask アプリの実行

Flask アプリケーションを実行し、ブラウザで動作を確認します。

`python app.py`

ブラウザで http://127.0.0.1:5000 にアクセスして、Hello, World! と表示されることを確認します。

注意: このステップで実際にエラーが発生せずに動作するプロジェクトを作成することが重要です。何か問題が発生した場合は、エラーメッセージを確認し、必要な修正を行ってください。

.gitignore の設定

プロジェクトのルートディレクトリに .gitignore ファイルを作成し、不要なファイルやディレクトリを除外します。これにより、バージョン管理の対象から除外するファイルを指定し、リポジトリをクリーンに保つことができます。

.gitignore ファイルに含めるべき一般的なファイルとディレクトリには以下のようなものがあります：

• 仮想環境のディレクトリ (venv/)
• Python のコンパイル済みファイル (__pycache__/, *.pyc, *.pyo, *.pyd)
• OS 特有のファイル (.DS_Store など)
• IDE やエディタの設定ファイル (.idea/, .vscode/)
• 環境変数ファイル (.env)
• その他の一時ファイルやログファイル (*.log, *.swp)

以下の内容は Python プロジェクトに適した .gitignore ファイルの例です。

venv/
pycache/
*.pyc
*.pyo
*.pyd
.Python
*.db
*.sqlite3
*.log
.DS_Store
*.swp
.idea/
.vscode/
.env
*.egg-info/

この設定により、指定されたファイルやディレクトリは git によって追跡されず、リポジトリに追加されることがなくなります。

ファイルの追加とコミット

プロジェクトのファイルをリポジトリに追加し、最初のコミットを行います。

git add .

このコマンドは、現在のディレクトリ内のすべてのファイルとディレクトリをステージングエリアに追加します。ステージングエリアとは、次にコミットされる変更を一時的に保存する場所です。このコマンドを実行することで、git にどのファイルが追跡され、コミットされるかを指示しています。

git commit -m "Initial commit with Flask setup"

このコマンドは、ステージングエリアに追加されたファイルのスナップショットを取り、ローカルリポジトリに保存します。-m オプションを使ってコミットメッセージを指定できます。ここでは「Initial commit with Flask setup」（Flask 設定を含む最初のコミット）としています。これにより、プロジェクトの現在の状態を保存し、将来的にこの状態に戻すことができます。

ローカルブランチ名の変更

デフォルトブランチ名を master から main に変更します。

git branch -M main

このコマンドは、現在のブランチの名前を main に変更します。-M オプションは強制的に名前を変更することを意味します。

GitHub リポジトリの作成

次に、GitHub に新しいリポジトリを作成します。

1. GitHub にログインします。
2. 右上のプラスアイコンをクリックし、「New repository」を選択します。
3. 「Repository name」には my-new-project と入力します。
4. 必要に応じて説明を追加し、リポジトリをパブリックまたはプライベートに設定します。
5. 「Create repository」ボタンをクリックします。

リモートリポジトリの追加

GitHub で作成したリポジトリをローカルリポジトリに追加します。

`git remote add origin https://github.com/username/my-new-project.git`

このコマンドを実行すると、ローカルリポジトリにリモートリポジトリが追加されます。origin はリモートリポジトリのデフォルト名であり、リモートリポジトリの URL を指定することで、ローカルの git リポジトリとリモートの GitHub リポジトリがリンクされます。これにより、ローカルでの変更をリモートにプッシュしたり、リモートから変更をプルしたりすることが可能になります。

リモートリポジトリへのプッシュ

最後に、ローカルリポジトリの内容を GitHub にプッシュします。

`git push -u origin main`

このコマンドは、ローカルリポジトリの main ブランチの内容をリモートリポジトリの main ブランチにプッシュします。-u オプションを使う。

以上の手順で、新しいプロジェクトの立ち上げから GitHub へのプッシュまでを完了できます。この方法を使用することで、プロジェクトのバージョン管理が容易になり、チームでの共同作業もスムーズに進めることができます。

注意点と迷ったときの対応

• 仮想環境の利用： 仮想環境を使うことで、プロジェクトごとの依存関係を管理しやすくなります。これにより、他のプロジェクトやシステム全体に影響を与えずに開発が進められます。
• エラーメッセージの確認： プロジェクトのセットアップ中にエラーが発生した場合、エラーメッセージを注意深く読み、必要な修正を行いましょう。エラーの内容を検索することで、多くの解決策が見つかります。
• ドキュメントの参照： Flask や git、GitHub の公式ドキュメントを参照することで、正確な情報を得ることができます。特に、新しい機能やベストプラクティスを学ぶためには、公式ドキュメントが最も信頼できるリソースです。
• コミュニティへの参加： オンラインフォーラムやコミュニティに参加することで、他の開発者からアドバイスを受けたり、問題を解決するためのヒントを得たりすることができます。

以上が新しいプロジェクトを立ち上げる際の基本的な手順と注意点です。これらのステップを踏むことで、効率的にプロジェクトを開始し、円滑に開発を進めることができるでしょう。お役に立てれば幸いです。

参考文献

• Git Documentation （英語）
• GitHub Docs（日本語）