update

.gitignore

@@ -91,7 +91,7 @@ ENV/
 **/migrations/*.py
 !**/migrations/__init__.py
 *.pyc
-conf/
+conf/*
 !conf/env.example.py
 db.sqlite3
 media/

README.zh.md

@@ -1,19 +1,20 @@
-## 
+##  启动
 
 ~~~bash
-1. 在 env.py 中配置数据库信息
+1.复制 ./conf/env.example.py 文件为一份新的到 ./conf 文件夹下，并重命名为 env.py
+2. 在 env.py 中配置数据库信息
 	mysql数据库版本建议：8.0
 	mysql数据库字符集：utf8mb4
-2. 安装依赖环境
+3. 安装依赖环境
 	pip3 install -r requirements.txt
-3. 执行迁移命令：
+4. 执行迁移命令：
 	python3 manage.py makemigrations
 	python3 manage.py migrate
-4. 初始化数据
+5. 初始化数据
 	python3 manage.py init
-5. 初始化省市县数据:
+6. 初始化省市县数据:
 	python3 manage.py init_area
-6. 启动项目
+7. 启动项目
 	python3 manage.py runserver 0.0.0.0:8000
 或使用 gunicorn :
   gunicorn -c gunicorn_conf.py application.asgi:application

conf/env.example.py

@@ -0,0 +1,54 @@
+import os
+
+from application.settings import BASE_DIR
+
+# ================================================= #
+# *************** mysql数据库 配置  *************** #
+# ================================================= #
+# 数据库 ENGINE ，默认演示使用 sqlite3 数据库，正式环境建议使用 mysql 数据库
+# sqlite3 设置
+DATABASE_ENGINE = "django.db.backends.sqlite3"
+DATABASE_NAME = os.path.join(BASE_DIR, "db.sqlite3")
+
+# 使用mysql时，改为此配置
+# DATABASE_ENGINE = "django.db.backends.mysql"
+# DATABASE_NAME = 'django-vue-admin' # mysql 时使用
+
+# 数据库地址 改为自己数据库地址
+DATABASE_HOST = "127.0.0.1"
+# # 数据库端口
+DATABASE_PORT = 3306
+# # 数据库用户名
+DATABASE_USER = "root"
+# # 数据库密码
+DATABASE_PASSWORD = "123456"
+
+# 表前缀
+TABLE_PREFIX = "dvadmin_"
+# ================================================= #
+# ******** redis配置，无redis 可不进行配置  ******** #
+# ================================================= #
+# REDIS_PASSWORD = ''
+# REDIS_HOST = '127.0.0.1'
+# REDIS_URL = f'redis://:{REDIS_PASSWORD or ""}@{REDIS_HOST}:6380'
+# ================================================= #
+# ****************** 功能 启停  ******************* #
+# ================================================= #
+DEBUG = True
+# 启动登录详细概略获取(通过调用api获取ip详细地址。如果是内网，关闭即可)
+ENABLE_LOGIN_ANALYSIS_LOG = True
+# 登录接口 /api/token/ 是否需要验证码认证，用于测试，正式环境建议取消
+LOGIN_NO_CAPTCHA_AUTH = True
+# 是否启动API日志记录
+API_LOG_ENABLE = locals().get("API_LOG_ENABLE", True)
+# API 日志记录的请求方式
+API_LOG_METHODS = locals().get("API_LOG_METHODS", ["POST", "UPDATE", "DELETE", "PUT"])
+# API_LOG_METHODS = 'ALL' # ['POST', 'DELETE']
+# ================================================= #
+# ****************** 其他 配置  ******************* #
+# ================================================= #
+ENVIRONMENT = "local"  # 环境，test 测试环境;prod线上环境;local本地环境
+ALLOWED_HOSTS = ["*"]
+# 系统配置存放位置：redis/memory(默认)
+DISPATCH_DB_TYPE = 'redis'
+