# deango_boilerplate

**Repository Path**: mrsonglad/deango_boilerplate

## Basic Information

- **Project Name**: deango_boilerplate
- **Description**: 方便快捷的项目脚手架模版，方便开发人员快速上手，开发业务功能。

1. 包含后台管理，用户身份验证，基于角色的数据、菜单的权限管理。
2. 创建前端功能页面、菜单，并根据用户 or 角色进行权限分配。
3. 用户管理，权限管理，角色管理。用户、角色在对应的业务功能/页面/菜单的读写等访问权限。
比如，销售内勤可以
4. API端点及权限管理，暴露给外部的不同API及可以访问的用户、角色
5. 

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-05-20
- **Last Updated**: 2026-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Deango Boilerplate

Django项目模板，包含完整的DevOps部署配置，支持部署到阿里云ECS。

## 项目结构

```
.
├── deploy/              # 部署相关脚本和配置
│   ├── deploy.sh       # 部署脚本
│   ├── entrypoint.sh   # Docker入口脚本
│   ├── supervisor.conf # Supervisor配置
│   ├── ecs-setup.sh    # ECS初始化脚本
│   └── backup.sh       # 数据库备份脚本
├── nginx/              # Nginx配置
│   ├── nginx.conf
│   └── conf.d/
│       └── default.conf
├── Dockerfile          # Docker镜像构建文件
├── docker-compose.yml  # Docker Compose配置
├── requirements.txt    # Python依赖
└── env.example         # 环境变量示例

```

## 快速开始

### 本地开发

1. 克隆项目
```bash
git clone https://gitee.com/deanying0114/deango_boilerplate.git
cd deango_boilerplate
```

2. 创建虚拟环境
```bash
python3 -m venv venv
source venv/bin/activate  # Linux/Mac
# 或
venv\Scripts\activate  # Windows
```

3. 安装依赖
```bash
pip install -r requirements.txt
```

4. 配置环境变量
```bash
cp env.example .env
# 编辑 .env 文件，设置你的配置
```

5. 运行项目
```bash
python manage.py runserver
```

### Docker部署

1. 配置环境变量
```bash
cp env.example .env
# 编辑 .env 文件
```

2. 构建并启动
```bash
docker-compose up -d
```

3. 查看日志
```bash
docker-compose logs -f
```

## 阿里云ECS部署

### 1. 服务器初始化

在ECS服务器上运行初始化脚本：

```bash
# 上传项目到服务器后
chmod +x deploy/ecs-setup.sh
./deploy/ecs-setup.sh
```

### 2. 配置项目

```bash
# 克隆项目（或上传项目文件）
cd /opt/deango_boilerplate

# 配置环境变量
cp env.example .env
vim .env  # 编辑配置文件
```

### 3. 部署

```bash
# 运行部署脚本
chmod +x deploy/deploy.sh
./deploy/deploy.sh
```

### 4. 配置域名和SSL（可选）

1. 配置域名解析到ECS公网IP
2. 申请SSL证书（可以使用Let's Encrypt免费证书）
3. 将证书文件放到 `nginx/ssl/` 目录
4. 修改 `nginx/conf.d/default.conf`，启用HTTPS配置
5. 重启Nginx容器：`docker-compose restart nginx`

## 常用命令

### Docker Compose

```bash
# 启动服务
docker-compose up -d

# 停止服务
docker-compose down

# 查看日志
docker-compose logs -f

# 重启服务
docker-compose restart

# 查看状态
docker-compose ps

# 进入容器
docker-compose exec web bash
```

### 数据库操作

```bash
# 运行迁移
docker-compose exec web python manage.py migrate

# 创建超级用户
docker-compose exec web python manage.py createsuperuser

# 备份数据库
./deploy/backup.sh
```

## 环境变量说明

主要环境变量（详见 `env.example`）：

- `SECRET_KEY`: Django密钥
- `DEBUG`: 调试模式（生产环境设为False）
- `ALLOWED_HOSTS`: 允许的主机
- `DB_*`: 数据库配置
- `REDIS_*`: Redis配置

## CI/CD

项目包含Gitee CI配置（`.gitee-ci.yml`），可以配置自动构建和部署。

## 监控和维护

### 日志查看

```bash
# 应用日志
docker-compose logs -f web

# Nginx日志
docker-compose logs -f nginx

# 所有服务日志
docker-compose logs -f
```

### 数据库备份

定期备份数据库：

```bash
./deploy/backup.sh
```

备份文件保存在 `backups/` 目录，自动清理7天前的备份。

## 安全建议

1. **生产环境必须修改**：
   - `SECRET_KEY`
   - 数据库密码
   - 启用HTTPS

2. **防火墙配置**：
   - 只开放必要端口（80, 443, 22）
   - 使用SSH密钥认证

3. **定期更新**：
   - 系统包更新
   - Docker镜像更新
   - Python依赖更新

## 故障排查

### 服务无法启动

1. 检查日志：`docker-compose logs`
2. 检查环境变量：确认 `.env` 文件配置正确
3. 检查端口占用：`netstat -tulpn | grep :8000`

### 数据库连接失败

1. 确认数据库容器运行：`docker-compose ps`
2. 检查环境变量中的数据库配置
3. 检查网络连接：`docker-compose exec web ping db`

## 许可证

MIT License

## 分支管理

本项目采用双分支策略，支持模板项目与业务功能分离：

- **main 分支**: 模板项目纯净版本，不包含业务功能
- **production 分支**: 业务功能版本，基于 main 分支创建，包含所有业务功能

### 快速创建业务分支

```bash
# 使用脚本创建业务分支
./scripts/create_business_branch.sh
```

### 同步模板更新

```bash
# 将 main 分支的更新同步到 production 分支
./scripts/sync_template_updates.sh
```

详细说明请查看：
- [分支管理策略](docs/分支管理策略.md) - 完整的分支管理策略说明
- [业务分支快速开始](docs/业务分支快速开始.md) - 快速开始指南

## 文档

详细文档请查看 `docs/` 目录：

- [产品需求文档](docs/产品需求文档.md) - 完整的产品需求说明（PRD）
- [部署指南](docs/部署指南.md) - 详细的阿里云ECS部署步骤
- [架构说明](docs/架构说明.md) - 项目架构和技术栈说明
- [开发指南](docs/开发指南.md) - 本地开发环境设置和开发流程
- [分支管理策略](docs/分支管理策略.md) - 模板与业务功能分离策略
- [业务分支快速开始](docs/业务分支快速开始.md) - 业务分支快速开始指南

## 联系方式

如有问题，请提交Issue或联系项目维护者。