Django

【Django】startappと失敗しない為の初期設定について

(最終更新月:2022年1月)

✔こんな疑問をお持ちの方へ向けて書かれた記事となります

「Djangoのプロジェクトを立ち上げて、設定も一通り完了。次は何するの?」

「Djangoでアプリを作り始めたい!どうやればいいの?」

「アプリを作るために最初からやっておいたほうが良いことって何?」

✔当記事を通じてお伝えすること

  • Djangoでappを立ち上げる方法
  • 最初に必ず行いたい初期設定「INSTALLED_APPS」と「urls.py」について

当記事をご覧いただければ、Djangoプロジェクトを立ち上げたあとにやるべきことがわかります

ぜひ最後までご覧ください。

appの立ち上げ

ターミナル上で、

python manage.py startapp app名

コマンドでappを立ち上げます

日報アプリ開発ということで、「nippo」というapp名にします

manage.pyというファイルがあるディレクトリへ移動した上で、

python manage.py startapp nippo

を実行します

【フォルダツリー】

itc
├── main
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
├── media_local
├── nippo
    ├── __init__.py
    ├── admin.py
    ├── apps.py
    ├── migrations
    ├── models.py
    ├── tests.py
    └── views.py
└── static_local

appの立ち上げは成功です

Djangoがappを認識し、今後作成していくHTMLファイルなどをブラウザで表示していくための設定を行っていきます

必ず行いたい初期設定

appを最初に立ち上げてやることは2つです

  1. settings.pyでappを認識させる
  2. urls.pyで作成したappとURLパスを紐づける

Djangoへappを認知させる

settngs.pyを開き、INSTALLED_APPSへ追記します

INSTALLED_APPS = [
    ...,
    ...,
    'nippo',
]

URLとappを紐づける

urls.pyファイルで設定を行います

mainフォルダ内nippoフォルダ(appフォルダ)内のそれぞれで行う必要があります

mainフォルダ > urls.py

...
from django.urls import path, include
 
urlpatterns = [
   ...,
   path('nippo/', include('nippo.urls')),
]

ポイントは、

  • includeをインポートすること
  • nippoフォルダ内のurls.pyとパス(「nippo/」)を紐づけること

nippo内でurls.pyを作成

パスを紐づけるためにnippoフォルダ内で新たにurls.pyを作る必要があります

空の「urls.py」をnippoフォルダ内に作成し、下記をコピペしておきましょう

nippo > urls.py

from django.urls import path
 
urlpatterns = [
  
]

urlpatternsは、現時点では空で構いません。

ポイントは、以下のとおり。

  • pathのインポート
  • urlpatternsリストを作成

今後はアプリ内のurls.pyに表示したいページのパスを入れていきます

urls.pyやpathなどについては詳しくこちらの記事で解説しています。

まとめ

当記事では、Djangoアプリの立ち上げとその設定方法について解説しました

アプリの立ち上げは、

python manage.py startapp アプリ名

で完了します

初期設定は、

  • settings.pyでINSTALLED_APPSに追記
  • urls.pyを追記、新規作成

することで完了となります

次回はアプリとデータベースを紐づける「モデルクラス」について解説していきます