steedos/steedos-project-template

华炎魔方模板项目

该项目是通过steedos cli命令行创建魔方项目时自动生成的模板项目，例如执行npx create-steedos-app my-app会自动创建名为my-app的项目。

镜像概述和主要用途

本模板项目为华炎魔方应用开发提供基础框架，集成了开发、运行所需的核心组件和配置结构，支持零代码和低代码两种开发模式，可快速构建企业级业务应用，并能将开发成果打包发布为软件包，用于部署或在华炎魔方应用市场售卖。

核心功能和特性

• 快速项目初始化：通过steedos cli一键创建标准化项目结构
• 多开发模式支持：同时支持零代码（界面化配置）和低代码（代码开发）两种方式
• 在线开发环境：兼容GitPod在线开发，免去本地环境配置繁琐流程
• 软件包管理：支持将项目发布为软件包，便于部署和分发
• 集成主流工具：内置JsReport报表开发、Node-Red系统集成等功能模块
• 环境变量管理：提供.env和.env.local文件分离配置，保护敏感信息

使用场景和适用范围

• 企业级业务系统快速开发
• 业务流程自动化与集成
• 报表设计与数据可视化
• 现有系统（如SAP、用友、金蝶）集成
• 快速原型验证与演示
• 第三方应用市场软件包开发

开发前准备

开通华炎魔方云服务

请按https://www.steedos.cn/docs/deploy/deploy-cloud%E5%BC%80%E9%80%9A%E5%8D%8E%E7%82%8E%E9%AD%94%E6%96%B9%E4%BA%91%E6%9C%8D%E5%8A%A1%E3%80%82

激活华炎魔方

参考https://www.steedos.cn/docs/deploy/deploy-activate%EF%BC%8C%E5%87%86%E5%A4%87%E8%BF%90%E8%A1%8C%E9%A1%B9%E7%9B%AE%E6%97%B6%E6%89%80%E9%9C%80%E7%9A%84%E4%B8%A4%E4%B8%AA%E6%BF%80%E6%B4%BB%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E3%80%82

注册GitPod账户

推荐使用GitPod在线开发，需先注册https://github.com/%E5%92%8Chttps://gitpod.io/%E8%B4%A6%E6%88%B7%E5%B9%B6%E7%99%BB%E5%BD%95%E3%80%82

获取项目

• Fork项目：Fork本项目到个人仓库，便于通过GitPod开发并提交代码
• 创建新项目：执行命令创建全新项目并提交到Git仓库
  npx create-steedos-app my-app

运行项目

启动开发环境

在浏览器中访问 https://gitpod.io/#{Fork后的Git仓库地址} 即可启动远程开发环境，环境已预装nodejs、mongodb、redis、vscode等组件。

示例地址：
https://gitpod.io/#https://github.com/steedos/steedos-project-template
（将#后地址替换为目标项目Git仓库地址）

自动初始化流程

打开项目后，系统会自动执行：

1. yarn 安装项目依赖
2. yarn start 启动项目

项目激活

首次运行时，控制台会提示"请配置环境变量STEEDOS_CLOUD_SPACE_ID和STEEDOS_CLOUD_API_KEY"，同时自动打开初始化界面：

1. 在云平台"管理控制台"的"我的魔方"中找到私有部署记录
2. 点击部署记录详情页右上角"复制激活参数"按钮
3. 将复制内容粘贴到初始化界面并提交
4. 系统会自动将环境变量保存到.env.local文件并跳转至登录界面
5. 使用私有部署的初始账户登录进入系统主界面

激活后.env.local文件示例：

[metadata]
METADATA_SERVER=https://5000-rose-fowl-9ece4ams.ws-us25.gitpod.io
METADATA_APIKEY=#自动填充的激活值

[steedos-cloud]
STEEDOS_CLOUD_SPACE_ID=#自动填充的激活值
STEEDOS_CLOUD_API_KEY=#自动填充的激活值

说明：METADATA_SERVER和METADATA_APIKEY用于元数据同步，详情参考https://beta.steedos.cn/docs/developer/getting-started#%E5%90%8C%E6%AD%A5%E5%85%83%E6%95%B0%E6%8D%AE%E3%80%82

开发项目

零代码开发

1. 参考https://www.steedos.cn/docs/admin/create_object%E5%9C%A8%E7%95%8C%E9%9D%A2%E4%B8%8A%E9%85%8D%E7%BD%AE%E4%B8%9A%E5%8A%A1%E9%9C%80%E6%B1%82
2. 开发完成后，参考https://www.steedos.cn/docs/developer/getting-started#%E5%90%8C%E6%AD%A5%E5%85%83%E6%95%B0%E6%8D%AE%E5%B0%86%E9%85%8D%E7%BD%AE%E5%90%8C%E6%AD%A5%E5%88%B0GitPod%E6%9C%AC%E5%9C%B0
3. 提交本地代码到Git仓库

低代码开发

参考https://www.steedos.cn/docs/developer/getting-started%E5%9C%A8GitPod%E4%B8%AD%E7%BC%96%E5%86%99%E4%BB%A3%E7%A0%81%E5%BC%80%E5%8F%91%E4%B8%9A%E5%8A%A1%E9%9C%80%E6%B1%82%E3%80%82

软件包发布

项目开发完成后可发布为软件包，用于：

• 直接安装到测试/生产环境
• 在华炎魔方应用市场定价售卖

详细流程参考https://www.steedos.cn/docs/developer/package%E3%80%82

目录说明

.steedos

独立npm项目，定义项目引用的软件包，在"设置>应用程序>软件包"界面可见，手动安装的软件包会回写至相关配置。

• .steedos/package.json：npm配置文件，在dependencies中定义需安装的软件包
• .steedos/steedos-packages.yml：配置项目引用的软件包，示例：

  yml
  '@steedos-labs/oa': # 软件包名称
    enable: true # 是否启用
    version: 2.1.20 # 版本号
    description: '' # 备注
    local: false # 是否为本地项目软件包（非.node_modules目录下需设为true）
    path: .steedos/node_modules/@steedos-labs/oa # 软件包目录
  

.vscode

vscode编辑器配置，setting.json定义yaml配置文件的schemas规范。

jsreport-app

独立JsReport项目，用于设计各类报表，详情参考https://www.steedos.cn/docs/developer/jsreport%E3%80%82

node-red-app

独立https://nodered.org/%E9%A1%B9%E7%9B%AE%EF%BC%8C%E9%80%9A%E8%BF%87%E5%8F%AF%E8%A7%86%E5%8C%96%E6%96%B9%E5%BC%8F%E8%BF%9E%E6%8E%A5SAP%E3%80%81%E7%94%A8%E5%8F%8B%E3%80%81%E9%87%91%E8%9D%B6%E7%AD%89%E7%B3%BB%E7%BB%9F%E5%8F%8A%E6%95%B0%E6%8D%AE%E5%BA%93%EF%BC%8C%E5%AE%9E%E7%8E%B0%E9%9B%86%E6%88%90%E9%9C%80%E6%B1%82%EF%BC%8C%E8%AF%A6%E6%83%85%E5%8F%82%E8%80%83https://www.steedos.cn/docs/developer/node-red%E3%80%82

services

华炎魔方微服务配置文件，内置三个微服务，每个软件包需以微服务形式集成。

steedos-app

项目内置默认软件包文件夹，启动时自动加载其中元数据和代码，DX工具默认同步元数据至此，详情参考https://www.steedos.cn/docs/developer/getting-started#%E5%90%8C%E6%AD%A5%E5%85%83%E6%95%B0%E6%8D%AE%E3%80%82

steedos-packages

分包管理目录，可存放各软件包文件夹，开发完成后可发布至NPM仓库或华炎魔方应用市场，第三方软件包也可存放于此，启动时自动加载。

storage

本地附件存储目录，若选择云服务存储附件则此目录为空。

核心配置文件

• moleculer.config.js：moleculer服务运行配置
• .env：环境变量配置（可提交至Git仓库），用于配置端口、URL等
• .env.local：本地环境变量配置（不提交至Git仓库），覆盖.env配置，存放密钥等敏感信息
• steedos-config.yml：华炎魔方系统配置，详情参考https://www.steedos.cn/docs/deploy/steedos-config
• package.json：NPM项目配置，管理依赖包，修改此文件可升级魔方平台内核版本，详情参考https://www.steedos.cn/docs/deploy/upgrade