ralopsmain/tns-mp-cms

镜像概述

本镜像为Marketplace CMS的开发环境容器，包含docker-compose配置文件，仅适用于开发环境（当前生产环境不安全）。需注意数据库 schema 频繁变更，需执行迁移命令。

核心功能

• 开发环境依赖管理（Poetry、nvm、node、npm、Parcel）
• 数据库迁移与初始化（PostgreSQL）
• 静态资源编译（SASS、ES6、Typescript）
• 测试套件运行（pytest、coverage）
• 代码风格检查（PEP8、Black、isort、flakehell）
• 静态类型检查（mypy）
• Git Flow版本控制支持

使用场景

• 本地开发环境快速搭建
• 项目功能测试与验证
• 静态资源编译与部署准备
• 代码风格与类型检查

配置说明

首次设置

本地开发环境版本要求

• Poetry == 1.1.4
• nvm == 0.37.2
• node == 14.15.4（通过nvm安装）
• npm == 6.14.10（通过nvm安装）
• parcel == 1.12.4（全局npm安装）
• docker == 20.10.2

安装nvm

1. 参考官方文档安装：https://github.com/nvm-sh/nvm
2. 执行命令：nvm install 14

安装Parcel打包工具

执行命令：npm install -g parcel-bundler

安装Poetry

1. 参考官方文档安装：[***]
2. 执行命令：poetry config virtualenvs.create true --local

安装Docker

若未安装Docker或无账号，参考：Docker入门

启动开发环境

安装依赖后，在包含pyproject.toml和docker-compose.yml的工作目录执行以下命令：

bash
docker-compose up

在另一个终端窗口执行：

bash
docker-compose exec app python manage.py migrate
docker-compose exec app python manage.py loaddata quickdb.json
docker-compose exec app python manage.py changepassword "admin@tnsinc.com"

创建超级用户命令会提示输入***和密码。

之后执行：

bash
npm run watch

该命令会通过热模块替换编译静态资源，保存时自动更新到静态目录。项目使用ES6和SASS作为资源语言。

生产环境静态资源部署

bash
cd packages/tns-mp-app-pkg/tns-mp-app
npm run build  # 编译生产环境静态资源（SASS、ES6、Typescript等）
cd ../../../
python manage.py collectstatic

本地运行测试套件

需运行Postgresql 12服务器，并创建角色testuser。在psql shell执行：

sql
CREATE ROLE testuser WITH PASSWORD 'test12345';
ALTER ROLE testuser WITH LOGIN;
ALTER ROLE testuser WITH CREATEDB;
CREATE DATABASE testprojectdb WITH OWNER testuser;

测试命令：

bash
docker-compose exec app coverage run -m pytest --pyargs tns_mp_app_tests

pytest会在每次运行后自动删除测试数据库。CI/CD中需从Docker镜像设置服务并创建用户。

Python代码风格指南

项目遵循PEP8和Black代码风格，通过Husky安装pre-commit钩子验证导入和代码 lint。

代码检查命令

• isort：isort .（格式化导入）
• black：black .（强制代码风格）
• flakehell：flakehell lint（代码检查）

静态类型检查

项目使用mypy进行Python静态类型检查，验证命令：

bash
mypy tns-mp-app

提交代码前，生成新的stub文件：

bash
stubgen tns-mp-app

本地项目设置

1. 从GitHub fork仓库
2. 克隆到本地机器
3. 提交至自己的fork
4. 仅从fork向原仓库的dev分支提交PR

版本控制

项目使用Git Flow语义版本控制：

• 启动新功能：git flow feature start <jira_card_number>
• 完成功能：git flow feature finish <jira_card_number>（自动合并到dev分支）