开篇: 码良的正确打开方式
本文为“码良系统的使用及设计实现”系列文章的第一篇。
码良是啥，咋没听过呢
没听过？今天你听过咯~
其实码良平台已经存在多时，今年6月份即首次上线，至今注册用户不足千人，代码仓库 star 数不足500， 维持着稳定的自（zeng）然（zhang）增（ting）长（zhi），也怪不得诸位没听过了。
![]()
想来，发布一点使用引导还是很有必要的。
码良是一个在线 H5 页面编辑器系统，用于快速制作 H5 页面。用户无需掌握复杂的编程技术，通过简单拖拽、少量配置即可制作精美的页面。同时，也为开发者提供了完备的编程接入能力，通过脚本和组件的形式获得强大的组件行为及交互控制的能力。
页面管理方便
按团队，项目的维度管理项目页面，方便团队协作。每个项目都可以有自己的权限，也非常适合多人管理一组项目。
图为项目管理界面
![]()
编辑操作高效
拖拽挪移，随心所欲。灵活组合，提高提高效率，保存模板，快速创建。
图为编辑器工作区界面
![]()
灵活丰富的扩展
可以对组件添加各种脚本，扩展组件的功能，并友好的提供给使用者配置参数
图为脚本编辑界面
![]()
组件接入简单
提供方便的脚手架创建组件，你可以把一个小功能，一个页面，一个项目做成一个组件，暴露参数给其他同学在编辑器里面填写
图为组件开发套件使用动图
![]()
谁可以使用码良？
程序员 程序员可以在码良平台按业务需要创建自己的组件，并暴露相应参数提供给产品或者设计师方便使用。也可以开发一些脚本扩展已有组件的功能。
![]()
设计师 设计师可以制作动画效果比较好的模板提供给更多的人使用
![]()
营销者 营销团队可以使用码良创建配置非常灵活的页面，配合获取到的访问等数据，可以直观的看到营销效果。
![]()
更详尽的介绍请移步官方文档。
码良的正确打开方式？
码良系统目前的体验/使用途径主要有两种：官方服务和 docker 私有部署。
方式一 官方服务
点击链接进入码良官网 https://godspen.ymm56.com 。
![]()
点击页面右上角“开始使用”菜单路由至登陆/注册页面。
![]()
使用邮箱注册并登陆账号，或者也可以通过第三方登陆，目前已接入 github 登陆。
至此，您已成功注册成为码良用户，接下来就可以使用码良服务了。
![]()
大体来说，码良系统分为了三部分，管理后台、页面编辑器、页面渲染器。
登入系统之后所看到的即是管理后台了。码良的页面管理分为三级，团队、项目和页面，团队是用户的聚合，项目是页面的聚合，页面面向终端用户。此外，管理后台提供了页面、项目、团队维度的受访数据，可以查看页面的受访情况。更详细的说明见官方文档。
页面编辑器是码良系统的核心，如下是编辑器的工作空间。
![]()
围绕组件操作，编辑器工作区大体分为组件候选区、组件树导航区、属性设置区、通用样式设置区、脚本设置（编辑）区、动画编辑区、可视化场景编辑区。看起来可能和市面上其他H5编辑器大同小异，需要特别说明的是，正是脚本编辑能力为页面编辑提供了无限可能，脚本可以扩展组件功能、可以被复用、几乎具备完全的组件控制能力，并支持 es6+ 语法。
页面保存发布后，码良贴心地提供了访问链接、短链以及二维码，点击页面设置面板即可看到。
以下是部分功能和页面的截图，要想更直观地感受码良平台的能力，速速注册体验吧。
精选模板页面
![]()
页面受访数据
![]()
资源管理
![]()
优雅的pc端展示效果
![]()
限于篇幅，码良平台的使用不能详尽介绍，更多细节请快快注册体验吧，官方文档也是图文并茂的，更有视频操作说明哦。
方式二 docker 私有部署
尽管官方服务免费注册即可使用，已经很方便了，但是我们还提供了私有 docker 部署能力，让您能将码良系统运行在自己的服务器上。
对于熟悉 docker 技术的同学来说，依照以下步骤即可迅速完成部署操作。
- clone 配置仓库到本地，该仓库提供了 docker-compose 配置。
- 准备一台服务器，当然，私人电脑也可，但是原则上不推荐 windows 系统机器。
- 安装 docker 环境、及 docker-compose，如果已有，请略过。
- 接下来依照 readme 说明逐步操作即可。需要提醒的是，一定要依照说明修改
config.yaml 配置。
对于不太熟悉 docker 技术的同学，在后续文章（docker 从入门到放弃中，/笑）中会详细一步步指引如何操作，敬请期待。
方式三 源码运行
说好的两种方式呢？方式三什么鬼
方式三目前不具备可操作性，可我还是想说，/任性
码良团队以极广的胸怀提供了免费官方服务的同时，又提供了docker 部署能力，同时计划着整个项目的开源，目前已经开源了最核心的部分——编辑器的代码。在不久的将来，完成代码整理和安全审查以后，我们会将所有代码开源，届时，您将可以直接以源码形式运行整个项目，此为方式三。
码良团队享受了开源精神带来的便利，也愿将自己的一点成果回馈给开源世界。
欢迎 star 问候，热烈欢迎。
链接区
github
ymm-tech/gods-pen
docker
ymm-tech/gods-pen-docker
码良官网
https://godspen.ymm56.com/
