【Django】GitHubからクローンして開発環境を整え、プロジェクトに参加するまで

概要

既にDjangoで開発中のプロジェクトに参加した際の手順を覚書としてまとめておきます。

手順

【下準備編】

①ローカルに開発用ディレクトリを作成

ご自分のPCで好きな場所にディレクトリ（ファイル）を作成します。

②GitHubからクローンする

GitHubからクローン用のURLをコピーします。

コマンドプロンプトを開きます。
作成したディレクトリに移動し、下記コマンドを実行します。

$ git clone コピーしたクローン用GitのURL

③作業用ブランチを切る

$ git branch                               //現在いるbranchを確認
$ git branch hogehoge                      //ブランチを切る
$ git checkout hogehoge                    //先ほど切ったブランチに移動

④仮想環境を構築する

$ python -m venv .venv                      //仮想環境構築
$ .venv\Scripts\activate　　　　　　　　　　 //仮想環境に入る（コマンドは環境によって異なる場合がある）

【ファイル作成編】

①.gitignoreファイル作成

.gitignoreをプロジェクト直下に作成します。
下の内容に加え、Git管理から外したいファイルを書き込みます。

.gitignore

.venv
.env
*.log
*.pyc
__pycache__/
db-volumes/
db.sqlite3

②requirements.txtの作成

.gitignoreと同様、プロジェクト直下に作成します。
コマンドプロンプトで以下を実行してrequirements.txtを作成してください。

$ pip install -r requirements.txt

③.envファイルを作成

プロジェクト直下に、.envファイルを作成します。
適当な文字列を作成し、SECRET_KEYを書き込みます。

.env

SECRET_KEY="hogehogehogehoge&%hogehogehogehoge&%hogehogehogehoge"

【データベースの設定編】

①mysqlを起動し、データベースを作成する

コマンドプロンプトで以下を実行してください。
（環境によってコマンドが異なる場合があります）

$ mysql -uroot -p                             //mysqlを起動し、パスワードを入力
$ show databases;                                       
$ create database hoge;                       //データベース作成
$ exit                                        //mysqlを抜ける

②local.pyを作成

local.pyをプロジェクト内のsettingsフォルダ下に作成します。
本番環境用のsettings.pyを参考に、以下内容を追加していきます。

settings.py

DEBUG = True
ALLOWED_HOSTS = ['localhost', '127.0.0.1]
DATABASES = {
        'NAME': 'hoge',
        'USER': 'root',
        'PASSWORD': 'xxxxx',
        'HOST': 'localhost',
        'PORT': '0000',
}

【アプリを動かす編】

①makemigrationsする

コマンドプロンプトで、以下コマンドを実行します。

$ python manage.py makemigrations
$ python manage.py migrate

②アプリを動かす

ここまでできたら、runserverして完了です。

$ python manage.py runserver