DjangoStarter 项目教程

DjangoStarter 项目教程

DjangoStarter 基于Django定制的快速Web开发模板😎，功能包括：Docker部署、缓存、消息队列、业务代码生成器、第三方登录接入、接口限流、Admin安全加固、RestFramework默认的API主页屏蔽等 项目地址: https://gitcode.com/gh_mirrors/dj/DjangoStarter

1. 项目的目录结构及介绍

DjangoStarter/
├── app/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── migrations/
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── config/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
├── requirements.txt
└── README.md

目录结构介绍

• app/: 包含项目的应用代码，通常包含模型、视图、管理界面等。

  • __init__.py: 使 app 成为一个 Python 包。
  • admin.py: 定义应用在 Django 管理界面的行为。
  • apps.py: 应用的配置文件。
  • migrations/: 存储数据库迁移文件。
  • models.py: 定义应用的数据模型。
  • tests.py: 编写应用的测试代码。
  • views.py: 定义应用的视图函数。

• config/: 包含项目的配置文件。

  • __init__.py: 使 config 成为一个 Python 包。
  • settings.py: 项目的全局配置文件，包含数据库配置、静态文件路径等。
  • urls.py: 项目的 URL 路由配置。
  • wsgi.py: 用于部署项目的 WSGI 配置文件。

• manage.py: Django 项目的管理脚本，用于运行服务器、创建应用、执行迁移等。

• requirements.txt: 列出项目依赖的 Python 包。

• README.md: 项目的说明文档。

2. 项目的启动文件介绍

manage.py

manage.py 是 Django 项目的管理脚本，提供了许多用于管理项目的命令。以下是一些常用的命令：

• 启动开发服务器:

  python manage.py runserver
  

• 创建应用:

  python manage.py startapp <app_name>
  

• 执行数据库迁移:

  python manage.py makemigrations
  python manage.py migrate
  

• 创建超级用户:

  python manage.py createsuperuser
  

3. 项目的配置文件介绍

config/settings.py

settings.py 是 Django 项目的全局配置文件，包含了许多重要的配置项。以下是一些关键配置项的介绍：

• 数据库配置:

  DATABASES = {
      'default': {
          'ENGINE': 'django.db.backends.sqlite3',
          'NAME': BASE_DIR / 'db.sqlite3',
      }
  }
  

• 静态文件路径:

  STATIC_URL = '/static/'
  STATICFILES_DIRS = [BASE_DIR / "static"]
  

• 模板路径:

  TEMPLATES = [
      {
          'BACKEND': 'django.template.backends.django.DjangoTemplates',
          'DIRS': [BASE_DIR / "templates"],
          'APP_DIRS': True,
          'OPTIONS': {
              'context_processors': [
                  'django.template.context_processors.debug',
                  'django.template.context_processors.request',
                  'django.contrib.auth.context_processors.auth',
                  'django.contrib.messages.context_processors.messages',
              ],
          },
      },
  ]
  

• 时区配置:

  TIME_ZONE = 'Asia/Shanghai'
  USE_TZ = True
  

config/urls.py

urls.py 是项目的 URL 路由配置文件，定义了 URL 与视图函数的映射关系。以下是一个简单的示例：

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('app.urls')),
]

config/wsgi.py

wsgi.py 是用于部署项目的 WSGI 配置文件，定义了如何与 WSGI 服务器进行交互。通常不需要手动修改此文件。

import os
from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
application = get_wsgi_application()

通过以上介绍，您应该对 DjangoStarter 项目的目录结构、启动文件和配置文件有了基本的了解。希望这些信息能帮助您更好地理解和使用该项目。

DjangoStarter 基于Django定制的快速Web开发模板😎，功能包括：Docker部署、缓存、消息队列、业务代码生成器、第三方登录接入、接口限流、Admin安全加固、RestFramework默认的API主页屏蔽等 项目地址: https://gitcode.com/gh_mirrors/dj/DjangoStarter