VSCode+Django+Mac開発環境構築
0.前提条件
・Python3インストール済み(ターミナルで python3 --version)
・VSCodeインストール済み
1.VSCode拡張機能の追加
2.仮想環境の作成
2.1仮想環境とは
自身のコンピュータのローカルで、バージョン(Django自体やライブラリ)の異なるDjangoアプリケーションを一括に管理しようとするとエラーが発生してしまいます。 そこでアプリケーションごとに、それぞれに適した環境を用意してあげる必要があります。これが仮想環境です。
2.2Djangoフォルダを作成し、my-appという仮想環境を作成する。
$mkdir Django
$cd Django
$python3 -m venv my-app
正しく実行されると、次の画像のようにDjangoフォルダ内に「my-app」という仮想環境が確認できます。
2.3作成された仮想環境を使用するには、ターミナルでアクティベートを実行する必要があります。
#Djangoフォルダ以内
$source my-app/bin/activate
以上で仮想環境の作成は完了です。(ディアクティベートはターミナルdeactivateを入力実行)
3.Djangoのインストール
pipとはPythonのライブラリを管理するためのツールで、Pythonをインストールした時点で使用できます。
仮想環境をアクティベートした状態で次のコマンドを実行してください。
$ pip3 install Django
Successfully installed...
と表示されたら仮想環境へのDjangoのインストールは完了です。
4.プロジェクトの作成
4.1ターミナルを開いて次のコマンドを実行するとプロジェクトが作成されます。
今回はサンプルとして作成する予定なので、プロジェクト名は「test_project」としました。
$ django-admin startproject test_project
4.2次にプロジェクトの中身を見ていきます。
$ cd test_project
$ ls
manage.pyとtest_projectフォルダが確認できます。 manage.pyは今後サーバーを動かす際やDBの変更がある場合に使用します。
4.3test_projectフォルダを開くと、5つのPythonファイルが確認できます。
フォルダ名 | 概要 |
---|---|
init.py | このファイルを含むディレクトリをPythonにパッケージとして認識させる役割があります |
asgi.py | 非同期処理に対応したWebアプリケーションを動作させるための、Python製Webサーバーです |
settings.py | ファイル名のとおり様々な設定を書いていくファイルです |
urls.py | アプリケーションの軸となるURLを設定していくファイルです |
wsgi.py | 本番環境等にデプロイする際にサーバーの設定を行います |
5.サーバーを立ち上げる
5.1ターミナルを開き、test_projectフォルダに移動します。
$cd test_project
# manage.pyが存在することをlsコマンドで確認します。
$ls
# データーベースが変更されたことがある場合は、まずmigrateを実行ください。
$ python manage.py migrate
# サーバ起動
$ python manage.py runserver
ターミナルに下記のように出力しましたら、Djangoサーバを正しく起動できました。
5.2ブラウザを開き、http://127.0.0.1:8000/にアクセスしてみましょう。
5.3上のようなページが表示されればDjangoが正しくインストールされました。
サーバーを終了したい場合は、ターミナルで「control+c」を押すと終了できます。
6.VSCodeでDjangoプロジェクトの開発
6.1作成した Django プロジェクトを開きます。
VSCodeに仮想環境のセッテイングを認識させるため、プロジェクトフォルダ(test_project)ではない、先ほど作った仮想環境のフォルダ(my-app)を含むフォルダ(Django)を開きください。
VSCodeで仮想環境のフォルダ(my-app)を含むフォルダ(Django)を開きます。
6.2Python インタプリタを選択する
venv(my-app)がついている仮想環境を選びましょう。
フォルダを開いた中に Python の仮想環境があると、自動的に認識されるはずです。
6.3デバッガを起動してみる
manage.py のパスを指定します。
(この手順の場合は、${workspaceFolder}/test_project/manage.py になります。)
あとは 「実行とデバッグ」 のボタンを押せばターミナルが起動して実行状態になるはずです。
実行状態になったら URL をブラウザにコピペしてアクセスしてみましょう。
(ブラウザを開き、http://127.0.0.1:8000/にアクセスしてみましょう。)
6.4上のようなページが表示されれば、VSCode上でDjangoのデバッグ環境が正しくインストールされました。
サーバーを終了したい場合は、ターミナルで「control+c」を押すと終了できます。