码良系统概览
码良(Gods Pen)是一套功能完善且具备高度扩展性的在线 Web 页面制作工具。它不仅仅是一个编辑器,更是一个包含服务端、管理后台及前端编辑器的完整解决方案。
项目架构
整个系统由三个核心项目构成,分工明确:
- gods-pen-server:码良服务端,负责业务逻辑与数据交互。
- gods-pen-admin:码良管理后台,用于系统配置与内容管理。
- gods-pen:码良编辑器,即用户直接操作的可视化界面,已于今年 7 月开源。
环境依赖
部署前需要准备好以下基础服务,其中大部分支持开箱即用,无需额外初始化:
- Elasticsearch (ES)
- Redis
- MySQL
- 邮件服务
- OSS 对象存储服务
注意:MySQL 是例外,必须使用
sql/init.sql脚本进行表结构和初始数据的初始化。
配置说明
配置文件位于 config/ 目录下,根据运行环境分为两类:
- 开发配置 (
config/config.dev.js):本地调试时使用。 - 生产配置 (
config/config.production.js):服务器正式部署时使用。
这种分离策略有助于避免开发环境与线上环境的配置冲突,确保部署安全。
部署流程
前期准备
除 MySQL 外,其他中间件服务通常无需特殊初始化操作。请确保网络连通性及端口开放。
启动与运维
在服务器端完成依赖安装后,可参考以下步骤进行服务管理:
- 启动服务:执行对应的启动脚本或命令。
- 终止服务:停止正在运行的进程。
- 查看日志:监控服务运行状态及错误信息。
具体命令取决于你的包管理器(如 npm, yarn)及进程管理工具(如 pm2),建议查阅项目根目录下的 package.json 获取准确指令。
详细文档
如需深入了解部署细节或遇到特定问题,请参考官方提供的部署手册:


