Bohr 项目使用文档

1. 项目目录结构及介绍

Bohr 项目的目录结构如下：

Bohr/
├── Bohr/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
│   └── asgi.py
├── manage.py
├── requirements.txt
└── README.md

目录结构介绍

• Bohr/: 项目的主目录，包含了项目的核心文件。

  • __init__.py: 使 Bohr 目录成为一个 Python 包。
  • settings.py: 项目的配置文件，包含了数据库配置、静态文件路径、中间件设置等。
  • urls.py: URL 路由配置文件，定义了项目的 URL 映射。
  • wsgi.py: WSGI 配置文件，用于部署项目。
  • asgi.py: ASGI 配置文件，用于异步服务器部署。

• manage.py: Django 项目的管理脚本，用于启动项目、运行迁移、创建超级用户等。

• requirements.txt: 项目依赖文件，列出了项目所需的所有 Python 包。

• README.md: 项目的说明文档，包含了项目的简介、安装步骤、使用说明等。

2. 项目启动文件介绍

manage.py

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

• 启动开发服务器:

  python manage.py runserver
  

  该命令会启动一个开发服务器，默认运行在 http://127.0.0.1:8000/。

• 创建数据库迁移:

  python manage.py makemigrations
  

  该命令会根据模型定义生成数据库迁移文件。

• 应用数据库迁移:

  python manage.py migrate
  

  该命令会将迁移文件应用到数据库中，创建或更新数据库表。

• 创建超级用户:

  python manage.py createsuperuser
  

  该命令会创建一个具有管理员权限的用户。

3. 项目配置文件介绍

settings.py

settings.py 是 Bohr 项目的配置文件，包含了项目的各种配置选项。以下是一些重要的配置项：

• 数据库配置:

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

  该配置项定义了项目使用的数据库引擎和数据库文件路径。

• 静态文件路径:

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

  该配置项定义了静态文件的 URL 前缀和静态文件的存储路径。

• 中间件配置:

  MIDDLEWARE = [
      'django.middleware.security.SecurityMiddleware',
      'django.contrib.sessions.middleware.SessionMiddleware',
      'django.middleware.common.CommonMiddleware',
      'django.middleware.csrf.CsrfViewMiddleware',
      'django.contrib.auth.middleware.AuthenticationMiddleware',
      'django.contrib.messages.middleware.MessageMiddleware',
      'django.middleware.clickjacking.XFrameOptionsMiddleware',
  ]
  

  该配置项定义了项目使用的中间件，用于处理请求和响应。

• 应用配置:

  INSTALLED_APPS = [
      'django.contrib.admin',
      'django.contrib.auth',
      'django.contrib.contenttypes',
      'django.contrib.sessions',
      'django.contrib.messages',
      'django.contrib.staticfiles',
      'Bohr',
  ]
  

  该配置项定义了项目中安装的应用，包括 Django 自带的应用和自定义的应用。

通过以上配置，Bohr 项目可以灵活地适应不同的开发和部署环境。