Django Snippets 项目技术文档

1. 安装指南

数据库设置（Windows）

1. 下载并安装最新版本的 PostgreSQL。
2. 运行安装程序，按照向导提示进行安装，保持默认设置。
3. 记录数据库超级用户（postgres）的密码，选择默认端口 5432 和默认区域设置。
4. 安装完成后，不要启动 Stack Builder，直接点击“完成”。
5. 打开 SQL Shell (psql)，选择默认值并输入之前记录的密码。
6. 运行以下命令创建数据库：

   CREATE DATABASE djangosnippets;
   

7. 关闭 SQL Shell (psql)。

环境变量配置

1. 将 .env.example 复制为 env.bat，并根据需要进行配置。
2. 使用以下模板，确保每行以 set 开头，并将 your_password 替换为之前记录的密码：

   set REDISTOGO_URL=redis://redis:6379/0
   set SECRET_KEY=p_o3vp1rg5)t^lxm9-43%0)s-=1qpeq%o7gfq+e4#*!t+_ev82
   set DEBUG=True
   set ALLOWED_HOSTS=0.0.0.0,127.0.0.1
   set DATABASE_URL=postgres://postgres:your_password@:5432/djangosnippets
   set DJANGO_SETTINGS_MODULE=djangosnippets.settings.development
   set SEARCHBOX_SSL_URL=http://elasticsearch:9200/
   set SESSION_COOKIE_SECURE=False
   

3. 每次打开新终端时，运行以下命令设置环境变量：

   env.bat
   

2. 项目的使用说明

开发环境设置

1. 在 Python 3.7 虚拟环境中，执行以下命令：

   cd requirements
   pip install -r development.txt
   cd ..
   python manage.py migrate
   

2. 启动开发服务器：

   python manage.py runserver
   

3. 创建超级用户并加载初始数据：

   python manage.py createsuperuser
   python manage.py loaddata fixtures/cab.json
   

4. 使用 Tailwind CSS 构建 site.css：

   npm run build
   

5. 现在可以在端口 8000 上使用开发版本的 Django Snippets。

运行测试

执行以下命令运行测试：

python manage.py test --settings=djangosnippets.settings.testing

3. 项目API使用文档

数据库API

• 创建数据库：

  CREATE DATABASE djangosnippets;
  

• 环境变量设置：

  set DATABASE_URL=postgres://postgres:your_password@:5432/djangosnippets
  

Django管理API

• 创建超级用户：

  python manage.py createsuperuser
  

• 加载初始数据：

  python manage.py loaddata fixtures/cab.json
  

• 运行开发服务器：

  python manage.py runserver
  

4. 项目安装方式

Docker 安装

1. 将 .env.example 复制为 .env，并根据需要进行配置。
2. 使用 Docker 进行本地开发和生产依赖测试：

   docker-compose -f docker-compose.yml build
   docker-compose -f docker-compose.yml up -d
   

3. 运行数据库迁移、创建超级用户并加载初始数据：

   docker-compose -f docker-compose.yml run web python manage.py migrate
   docker-compose -f docker-compose.yml run web python manage.py createsuperuser
   docker-compose -f docker-compose.yml run web python manage.py loaddata fixtures/cab.json
   

4. 构建静态文件：

   npm run build
   docker-compose -f docker-compose.yml run web python manage.py collectstatic
   

生产环境设置

生产环境目前针对 Heroku 进行了优化，设置过程大部分是自动的。生产环境的配置在 djangosnippets.settings.production 模块和 requirements.txt 文件中。