# DJANGO项目脚手架

**Repository Path**: coder_jk/scaffold-of-django-project

## Basic Information

- **Project Name**: DJANGO项目脚手架
- **Description**: 一个基于DJANGO框架的脚手架，其中配置了一些常用的组件（mysql、redis）、生产环境的容器（uwsgi）、自动化部署的脚本（docker+docker-compose）等。
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2022-04-06
- **Last Updated**: 2022-04-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DJANGO项目脚手架

#### 介绍

​		一个基于DJANGO框架的脚手架，其中配置了一些常用的组件（mysql/redis）、生产环境的容器（uwsgi+nginx）、自动化部署的脚本（docker+docker-compose）等。

#### 软件架构

​		django + uwsgi +  nginx + docker-compose + mysql + redis + celery。

#### 安装教程

下载方式：

```		shell
 git clone https://gitee.com/orystal/scaffold-of-django-project.git
```

1. 本地测试：

   配置虚拟环境，安装依赖包，修改manage.py中的配置文件为 local_settings ，正常启动。

   ```shell 
   pip install -r requirements.txt -i http://mirrors.aliyun.com/pypi/simple/ --timeout=100 --trusted-host mirrors.aliyun.com
   ```

2. 生产环境：

   2.1 先安装 docker 和 docker-compose

   2.2 再进入项目根目录，修改mysql、redis、nginx 等组件的相关配置。nginx 的配置文件是 mysite.conf
   
   2.3 修改第三方组件的相关配置后，执行以下命令即可部署上线：
   
   ```shell
   chmod +x install.sh
   ./install.sh
   ```

####  说明

1. 环境区分：

   ​		本地环境与生产环境分开配置：local_settings.py 和 product_settings.py 。本地环境（IDE）默认使用 local_settings.py ，可在manage.py 文件中更改；生产环境（docker + uwsgi ）默认使用 product_settings.py，可在  wsgi.py 文件中更改。 

2. mysql:

   ​		本地环境，自行修改本地配置文件（local_settings.py）中的 mysql 连接信息。

   ​		生产环境，修改 docker-compose.yml 中的数据库创建信息 和 修改生产配置文件（product_settings.py）中的 mysql 连接信息。

3. redis:

   ​		本地环境，自行修改本地配置文件（local_settings.py）中的 redis 连接信息。

   ​		生产环境，修改 docker-compose.yml 中的数据库创建信息 和 修改生产配置文件（product_settings.py）中的 redis 连接信息。
   
4. celery:

   ​		celery 也分了两个配置文件，默认配置的是：product_config，自行根据环境进行配置。

#### 注意

1. 生产使用中记得修改配置文件中的 SECRET_KEY 。

2. 新注册的 app：

   2.1  需要将对应的 migrations 目录，通过 docker-compose.yml 挂载到物理机上（**重要：本地测试生成的迁移文件不要上传**）。从而保障容器重构时，migrations 中的数据与数据库中的数据一至。

   2.2 在 install.sh 中创建和初始化 migrations 的  \__init__.py 文件。