SAOS 项目启动与配置教程

1. 项目目录结构及介绍

SAOS项目的目录结构如下：

saos/
├── .gitignore           # Git忽略文件
├── .env                 # 环境变量配置文件
├── Dockerfile           # Docker构建文件
├── README.md            # 项目说明文件
├── docker-compose.yml   # Docker容器编排文件
├── requirements.txt     # 项目依赖文件
├── manage.py            # Django管理脚本
├── saos/                # 项目主体目录
│   ├── __init__.py      # 初始化文件
│   ├── settings.py      # 项目配置文件
│   ├── urls.py          # URL路由配置文件
│   └── wsgi.py          # WSGI配置文件
└── utils/               # 工具类目录
    ├── __init__.py
    └── helpers.py       # 辅助函数文件

以下是各目录和文件的简要介绍：

• .gitignore：指定Git应该忽略的文件和目录。
• .env：存放项目的环境变量，如数据库配置、API密钥等。
• Dockerfile：用于构建Docker镜像。
• README.md：项目的基本介绍和说明。
• docker-compose.yml：定义服务的容器编排，包括服务、网络和卷。
• requirements.txt：列出项目运行所需的Python包。
• manage.py：Django项目的管理接口。
• saos/：项目主体目录，包含项目的核心代码。
  • __init__.py：确保Python解释器将目录作为包处理。
  • settings.py：项目的配置信息，如数据库连接、应用列表、中间件等。
  • urls.py：定义项目的URL路由。
  • wsgi.py：WSGI配置文件，用于部署项目。
• utils/：包含项目所需的各种工具类和辅助函数。

2. 项目的启动文件介绍

项目的启动文件是manage.py，它是Django项目自带的命令行工具，可以用来运行各种管理任务。最常用的启动命令是：

python manage.py runserver

该命令会启动Django的开发服务器，默认监听在8000端口。可以通过指定不同的IP地址和端口来运行服务器，如：

python manage.py runserver 0.0.0.0:8000

3. 项目的配置文件介绍

项目的配置文件是saos/settings.py，它包含项目的所有配置信息。以下是一些主要的配置项：

• DEBUG：调试模式，开发时设置为True，上线后应设置为False。
• SECRET_KEY：用于签名session等数据，应保持安全。
• DATABASES：数据库配置，包括数据库类型、名字、用户、密码等。
• INSTALLED_APPS：项目中安装的应用列表。
• MIDDLEWARE：中间件配置，处理请求和响应。
• TEMPLATES：模板引擎配置。
• STATIC_URL和STATIC_ROOT：静态文件配置。

在settings.py中，通常需要根据实际情况调整数据库配置、静态文件存储位置、第三方应用配置等。

在启动项目前，确保.env文件中已设置好所需的环境变量，然后可以使用以下命令加载环境变量：

python -m django runserver

这样就可以启动项目了。如果使用Docker，可以构建镜像并运行容器：

docker-compose up