コメントと説明を追加

Author: tokibito

Diff for: README.md

@@ -19,6 +19,7 @@ DjangoフレームワークとJavaScriptでアプリケーションを作るサ
    * venv
    * Djangoフレームワーク
       * Django REST Framework
+      * django-debug-toolbar
 * フロントエンド
    * Babel
    * webpack
@@ -58,8 +59,10 @@ DjangoフレームワークとJavaScriptでアプリケーションを作るサ
    * Vueに依存しないほうがテストコードを書きやすいから
    * Vueインスタンスをエントリポイント(index.js)外のJavaScriptコードに渡さない
       * エントリポイントではVueに依存しないコントローラクラスのインスタンスを生成し、データはコントローラに持たせる
-         * 規模が大きくなったらストアを用意するかも
    * コンポーネントから外へVueインスタンスを渡さない
+   * Bootstrapのモーダルダイアログを表示する場合は、コントローラから呼び出すのではなく、コントローラからの戻り値をコンポーネント側で使って表示制御する
 * django-webpack-loaderを使っていない
    * なるべく依存を増やさない
    * 必要になったら入れよう
+* DjangoのCSRF対策をフロントエンドからも利用する
+   * Cookieに書き込まれたCSRFトークンをAPI呼び出し時に利用しています

Diff for: note_client/src/common.js

@@ -1,3 +1,7 @@
+/*
+ * 共通モジュール
+ * BootstrapVueやFontAwesomeとCSSを適用するために使います
+ */
 import 'bootstrap/dist/css/bootstrap.css'
 import 'bootstrap-vue/dist/bootstrap-vue.css'
 import './style/font-awesome-config.scss'

Diff for: note_client/src/index.js

@@ -1,3 +1,6 @@
+/*
+ * クライアントアプリケーションのエントリポイント
+ */
 import 'bootstrap/dist/css/bootstrap.css'
 import 'bootstrap-vue/dist/bootstrap-vue.css'
 import './style/font-awesome-config.scss'

Diff for: note_client/webpack.config.js

@@ -4,11 +4,11 @@ var path = require('path');
 module.exports = {
   entry: {
     babel_polyfill: 'babel-polyfill',
-    index: './src/index.js',
-    common: './src/common.js'
+    index: './src/index.js',  // アプリケーションページ用
+    common: './src/common.js'  // 共通ページ用
   },
   output: {
-    path: path.resolve('./build'),
+    path: path.resolve('./build'),  // ビルドしたファイルの出力先
     filename: '[name].js'
   },
   resolve: {

Diff for: note_server/note/models.py

@@ -3,6 +3,8 @@
 
 
 class Page(models.Model):
+    """ページモデル
+    """
     class Meta:
         verbose_name = verbose_name_plural = "ページ"
         ordering = ('id',)

Diff for: note_server/note/serializers.py

@@ -5,6 +5,10 @@
 
 
 class PageSerializer(serializers.ModelSerializer):
+    """Pageモデルのシリアライザ
+
+    更新系は、titleとcontentのみ許可
+    """
     class Meta:
         model = Page
         fields = [

Diff for: note_server/note/views.py

@@ -6,15 +6,21 @@
 
 
 class PageViewSet(ModelViewSet):
+    """Pageモデルの一覧、作成、更新、削除のAPI
+    """
     serializer_class = PageSerializer
+    # ログイン済みの場合だけ許可
     permission_classes = (IsAuthenticated,)
 
     def get_queryset(self):
+        # ログイン中のユーザーのページのみを返す
         return Page.objects.filter(
             user=self.request.user,
         ).order_by('-updated_at', '-id')
 
     def perform_create(self, serializer):
         """追加時のフック
+
+        ログイン中のユーザー情報を記録します
         """
         serializer.save(user=self.request.user)

Diff for: note_server/note_server/settings.py

@@ -13,6 +13,7 @@
 DEBUG = True
 
 ALLOWED_HOSTS = ['*']
+# django-debug-toolbarはINTERNAL_IPSからの通信でのみ有効になるため、VMのNATのアドレスを入れています
 INTERNAL_IPS = ['192.168.33.1']
 
 # Application definition
@@ -39,6 +40,7 @@
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]
 
+# デバッグ時のみミドルウェアを有効にします
 if DEBUG:
     MIDDLEWARE.append(
         'debug_toolbar.middleware.DebugToolbarMiddleware',
@@ -50,6 +52,7 @@
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
         'DIRS': [
+            # プロジェクト直下のtemplatesディレクトリにテンプレートファイルをまとめます
             os.path.join(BASE_DIR, 'templates'),
         ],
         'APP_DIRS': True,
@@ -111,6 +114,7 @@
 
 STATIC_URL = '/static/'
 
+# ビルドされたクライアントアプリケーションをDjangoのstaticfilesから参照します
 STATICFILES_DIRS = [
     ('client', os.path.join(os.path.dirname(BASE_DIR), 'note_client/build')),
 ]

Diff for: note_server/note_server/urls.py

@@ -10,27 +10,33 @@
 from rest_framework.documentation import include_docs_urls
 
 urlpatterns = [
+    # 管理画面
     path('admin/', admin.site.urls),
+    # ログイン
     path(
         'login',
         auth_views.LoginView.as_view(
             template_name='login.html',
             redirect_authenticated_user=True),
         name='login'),
+    # ログアウト
     path(
         'logout',
         auth_views.LogoutView.as_view(
             next_page='login'),
         name='logout'),
 
-    # API
+    # APIドキュメント
     path('docs/', include_docs_urls(title='API', public=False)),
+    # ノートアプリケーションのAPI
     path('note/', include('note.urls')),
 
+    # ノートアプリケーションの画面
     path('', ensure_csrf_cookie(login_required(render)),
          kwargs={'template_name': 'index.html'}, name='index'),
-] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
+] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)  # staticfilesのファイルを配信
 
+# デバッグ時のみdjango-debug-toolbarのURLを追加
 if settings.DEBUG:
     import debug_toolbar
     urlpatterns = [