Skip to content

Commit

Permalink
upgrade template @2.1.59
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 26, 2021
1 parent da74621 commit c592c14
Show file tree
Hide file tree
Showing 32 changed files with 2,895 additions and 14 deletions.
81 changes: 80 additions & 1 deletion packages/create-steedos-app/templates/default/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,80 @@
# steedos-apps
# 华炎魔方模板项目

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

## .steedos

该文件夹是一个独立的npm项目,在该项目中可以定义要在华炎魔方项目中引用哪些软件包。
这里定义的软件包都可以在“设置”应用的“应用程序->软件包”界面上看到,且在界面上手动安装的软件包会回写到该文件夹的相关配置文件中。

更多详情请参考文档:[软件包发布与安装](https://www.steedos.cn/docs/developer/package)

### .steedos/package.json

这是npm项目的配置文件,可以在`dependencies`中定义要安装哪些软件包到本地。

### .steedos/steedos-packages.yml

在该文件中可以配置当前华炎魔方项目要引用哪些软件包,包括之前在`package.json`文件依赖项中定义的软件包也需要在这里引用才能生效。
每个软件包可以定义的属性说明如下:

```yml
'@steedos-labs/oa': # 软件包名称
enable: true #是否启用该软件包
version: 2.1.20 # 软件包版本号
description: '' # 软件包备注
local: false # 是否是本地项目下的软件包,只要不是安装到`.steedos/node_modules`文件夹下的软件包都应该设置为true
path: .steedos/node_modules/@steedos-labs/oa #软件包所在文件目录,所有软件包都必须在这里填写软件包所在硬盘目录
```
## .vscode
该文件夹中保存的是vscode编辑器的配置文件,其中setting.json文件中定义了低代码开发时,编写yaml配置文件需要符合的schemas规范。
## jsreport-app
这是一个独立的 [JsReport](https://jsreport.net/) 项目,用于设计各种报表。详情请参考 [JsReport报表开发向导](https://www.steedos.cn/docs/developer/jsreport)。
## node-red-app
这是一个独立的 [Node-Red](https://nodered.org/) 项目,可以通过可视化开发方式,连接SAP、用友、金蝶等主流业务系统及各种数据库,实现各种集成业务需求。详情请参考 [与现有业务系统整合](https://www.steedos.cn/docs/developer/node-red)。
## 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)。
## steedos-packages
当项目需要分包管理时,可以把各个软件包文件夹存放到该文件夹中,软件包开发完成后可以发布到NPM仓库中,也可以发布到华炎魔方应用市场售卖。
如果需要,也可以把第三方软件包复制到此文件夹中,华炎魔方启动时会自动加载其中每个软件包的元数据及相关代码。
## storage
这是魔方项目存放附件到本地时,附件文件所在文件夹,您也可以选择把附件存入云服务,这样的话,该文件夹就始终是空的。
## moleculer.config.js
使用moleculer运行服务时的配置文件。
## .env
环境变量配置文件,可以配置端口、URL 等环境变量,与`.env.local`文件的主要区别是该文件可以提交到git仓库中。

## .env.local

环境变量配置文件,用于保存本地环境的配置,会覆盖`.env`文件中的配置。
该文件中可以存放密钥等敏感信息,已加入到`.gitignore`文件清单,不会提交到git仓库中。

## steedos-config.yml

华炎魔方配置文件,详情请参考文档 [环境变量、系统参数配置向导](https://www.steedos.cn/docs/deploy/steedos-config)。

## package.json

华炎魔方项目是一个标准的NPM项目,该文件用于配置项目依赖的 npm 包。
如果需要升级魔方平台内核版本,也是修改此文件,详情请参考文档 [升级已有老版本项目](https://www.steedos.cn/docs/deploy/upgrade)。
16 changes: 8 additions & 8 deletions packages/create-steedos-app/templates/default/_package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@steedos/steedos-project-template",
"version": "2.1.58",
"version": "2.1.59",
"private": false,
"repository": "https://github.com/steedos/steedos-project-template.git",
"description": "",
Expand All @@ -27,13 +27,13 @@
"author": "",
"license": "ISC",
"dependencies": {
"@steedos/service-charts": "2.1.58",
"@steedos/service-metadata-server": "2.1.58",
"@steedos/service-mongodb-server": "2.1.58",
"@steedos/service-package-loader": "2.1.58",
"@steedos/service-package-registry": "2.1.58",
"@steedos/service-pages": "2.1.58",
"@steedos/service-steedos-server": "2.1.58",
"@steedos/service-charts": "2.1.59",
"@steedos/service-metadata-server": "2.1.59",
"@steedos/service-mongodb-server": "2.1.59",
"@steedos/service-package-loader": "2.1.59",
"@steedos/service-package-registry": "2.1.59",
"@steedos/service-pages": "2.1.59",
"@steedos/service-steedos-server": "2.1.59",
"aliyun-sdk": "1.12.3",
"async-retry": "^1.3.1",
"aws-sdk": "2.0.23",
Expand Down
2 changes: 2 additions & 0 deletions packages/create-steedos-app/templates/default/env
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ STEEDOS_PUSH_MI_APPSECRET=
STEEDOS_PUSH_MI_PRODUCTION=
DEVELOPER_STANDARD_OBJECTS=true
DEFAULT_PACKAGE_PATH=
STEEDOS_CLOUD_LOGO_URL=
STEEDOS_CLOUD_LOGO_SQUARE_URL=

# saas初始化工作区信息
STEEDOS_CLOUD_API_KEY=
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@
},
"dependencies": {
"jsreport": "^2.11.0"
}
}
},
"version": "2.1.59"
}
Loading

0 comments on commit c592c14

Please sign in to comment.