create-steedos-app 2.5.17-beta.1 → 2.5.17-beta.10

package/dist/default/README-template.md

@@ -1,64 +1,87 @@
-华炎魔方模版项目
-===
 
-<p align="center">
-<a href="./README_en.md">English</a>
-<a href="https://www.steedos.cn/docs/"> · 文档</a>
-<a href="https://www.steedos.cn/videos/"> · 视频</a>
-<a href="https://demo.steedos.cn"> · 试用</a>
-</p>
+# Steedos DX Project Template
 
+Steedos Developer Experience (DX) is a new way to manage and develop apps on the Steedos Low-Code Platform across their entire lifecycle. It brings together the best of the Low-Code Platform to enable source-driven development, team collaboration with governance, and new levels of agility for custom app development on Steedos.
 
-<p align="center" style="border-top: solid 1px #cccccc">
-  华炎魔方是 <a href="https://developer.salesforce.com/developer-centers/developer-experience" target="_blank">Salesforce Developer Experience (DX)</a> 的开源替代方案，将低代码技术与 <a href="https://www.steedos.cn/docs/deploy/devops"> DevOps 工具</a> 结合，实现敏捷开发的新高度。 
-</p>
+- [What is Steedos DX](https://docs.steedos.com/developer/setup/steedos-dx)
+- [What is Steedos Package](https://docs.steedos.com/developer/package/overview)
 
-<h3 align="center">
- 🤖 🎨 🚀
-</h3>
+# Getting Started
 
+## Run Steedos Platform
 
-# 快速向导
+First, you must run Steedos Platform. You can follow the [Self Hosting Tutorial](/deploy/deploy-docker) to deploy Steedos on a server, or launch a local Steedos Platform.
 
-## 启动华炎魔方
+```bash
+cd steedos-platform
+docker-compose up
+```
+
+You can also refer to the instructions in the `./steedos-platform` dir to run Steedos Platform with Node.js.
+
+### Register Admin Account
+
+Upon its first launch, the system will prompt you to register an account and create an organization. This account will also become the administrator account for the organization.
 
-开发软件包之前，先启动花华炎魔方服务。
+### Create an API Key
 
-1. 将 .env 复制为 .env.local，并修改相关配置参数。
-2. 使用 docker 启动华炎魔方。
+You can log in to the Steedos server with administrator credentials, go to the settings app, select the API Key menu, and create a new API Key.
+
+## Setup Environment Variable
+
+### Setup TRANSPORTER
+
+The Steedos package operates using the [Moleculer](https://moleculer.services/docs) microservices framework, connecting microservices through the configuration of a unified Transporter.
+
+[Moleculer Transporter](https://moleculer.services/docs/0.14/networking) is an important module if you are running services on multiple nodes. Transporter communicates with other nodes. It transfers events, calls requests and processes responses …etc. If multiple instances of a service are running on different nodes then the requests will be load-balanced among them.
 
 ```bash
-docker-compose up
+TRANSPORTER=redis://127.0.0.1:6379
 ```
+:::tip
+Please make sure the TRANSPORTER you configured matches the Steedos server you wish to connect to and that the network is interconnected. 
+:::
 
-## 访问华炎魔方
+:::danger
+For running in a production environment, be sure to configure the Redis password.
+:::
 
-打开浏览器，访问 http://127.0.0.1:5000，进入华炎魔方。
+### Setup Metadata Server
 
-进入设置应用，可以：
-- 创建自定义对象
-- 创建应用
-- 创建微页面
+Setup environment variables required for metadata synchronization.
 
-## 开发软件包
+```bash
+steedos source:config
+```
+
+- Metadata Server: METADATA_SERVER is the ROOT_URL of the Steedos server you wish to connect to.
+- Metadata API Key: METADATA_APIKEY is used to authenticate your identity. 
 
-可以使用微服务的方式扩展华炎魔方。可以参考 services 文件夹下的例子。
+This command writes environment variables into the .env.local file, 
 
 ```bash
-yarn
-yarn start
+METADATA_SERVER=
+METADATA_APIKEY=
 ```
 
-## 使用 Node-RED
+You can also set the above environment variables directly without running the command.
 
-[Node-Red](https://nodered.org/) 是 IBM 开源的服务端低代码开发工具，提供了可视化的开发环境，开发华炎魔方微服务。
+## Run Steedos Packages
 
-- 创建定时任务
-- 自定义微服务
-- 自定义API
-- 自定义触发器
-- 接收和推送消息
+### Install Dependences
 
 ```bash
-yarn nodered
+yarn
 ```
+
+### Run Packages
+
+You can use the [moleculer-runner](https://moleculer.services/docs/0.14/runner) command to launch the steedos packages.
+
+```bash
+yarn moleculer-runner steedos-packages/*/package.service.js --hot --repl
+```
+
+:::tip
+Please note that the Steedos DX project supports multi-package development, and the above command simultaneously launches all packages under the steedos-packages folder.
+:::

package/dist/default/moleculer.config.js

@@ -15,4 +15,4 @@ module.exports = {
 	started(broker) {
 	},
 
-};
+};

package/dist/default/package.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "steedos-packages/*"
+  ],
+  "repository": "git://github.com/steedos/steedos-project-template.git",
+  "scripts": {
+    "start": "moleculer-runner steedos-packages/*/package.service.js --hot --repl",
+    "repl": "moleculer-runner --repl"
+  },
+  "dependencies": {
+    "@steedos/service-package-loader": "^2.5"
+  },
+  "devDependencies": {
+    "moleculer-repl": "^0.7.4"
+  }
+}

package/dist/default/steedos-packages/example-service/package.service.js

@@ -0,0 +1,86 @@
+const project = require('./package.json');
+const packageLoader = require('@steedos/service-package-loader');
+
+module.exports = {
+  name: "example-service",
+
+	mixins: [packageLoader],
+
+  metadata: {
+    $package: {
+        name: project.name,
+        version: project.version,
+        path: __dirname,
+        isPackage: true
+    }
+  },
+
+  actions: {
+    hello: {
+      // 使用微服务方式定义 API 接口。
+      // 访问地址： GET /service/api/example-service/hello/:name
+      rest: { method: 'GET', path: '/hello/:name' },
+      handler(ctx) {
+        return {
+          data: 'Welcome ' + ctx.params.name
+        }
+      }
+    },
+    me: {
+      rest: { method: 'GET', path: '/me' },
+      // 在微服务中获取当前登录的用户信息
+      async handler(ctx) {
+        return ctx.meta.user
+      }
+    },
+    // 在微服务中调用graphql查询数据库
+    graphqlQuerySpaceUsers: {
+      rest: { method: 'GET', path: '/graphql' },
+      async handler(ctx) {
+        return await this.broker.call('api.graphql', {
+          query: `
+            query {
+              space_users(filters: ["user", "=", "${ctx.meta.user.userId}"]) {
+                name
+                organization__expand {
+                  name
+                }
+              }
+            }
+          `},
+          // 如果查询 GraphQL 需要带上当前用户的权限，需要传入 user 属性。
+          {
+            user: ctx.meta.user
+          }
+        )
+      },
+    },
+    // 在微服务中调用objectql查询数据库, 需要 mixins: [require('@steedos/service-object-mixin')],
+    objectqlQuerySpaceUsers: {
+      rest: { method: 'GET', path: '/objectql' },
+      async handler(ctx) {
+        return await this.getObject('space_users').find(
+            {
+              filters: ['user', '=', ctx.meta.user.userId]
+            },
+            ctx.meta.user
+        )
+      }
+    },
+    // 使用微服务定义触发器
+    spaceUsersBeforeUpdate: {
+      trigger: { listenTo: 'space_users', when: ['beforeUpdate', 'beforeInsert']},
+      async handler(ctx) {
+        this.broker.logger.info('spaceUsersBeforeUpdate', ctx)
+      }
+    }
+  },
+  events: {
+    "@space_users.updated": {
+      handler(payload) {
+          // 监听人员修改事件
+          this.broker.logger.info(payload);
+      }
+    }
+  }
+}

package/dist/default/{docker-compose.yml → steedos-platform/docker-compose.yml}

@@ -6,20 +6,23 @@ services:
     image: steedos/steedos-community:2.5
     ports:
       - "5000:5000"
-    env_file:
-      - .env.local
     environment:
       - PORT=5000
+      - ROOT_URL=http://127.0.0.1:5000
       - MONGO_URL=mongodb://mongodb:27017/steedos
       - MONGO_OPLOG_URL=mongodb://mongodb:27017/local
-      - TRANSPORTER=nats://nats:4222
-      - CACHER=redis://redis:6379
+      - TRANSPORTER=redis://redis:6379
+      - CACHER=redis://redis:6379/1
+      - STEEDOS_STORAGE_DIR=./steedos-storage
+    volumes:
+      - "./steedos-storage:/steedos-storage"
     depends_on:
       mongodb:
         condition: service_healthy
         
   redis:
-    image: redis:6.2
+    image: redis:6.2.10
+    command: "redis-server --save \"\" --appendonly no --loglevel warning"
     ports:
       - "6379:6379"
   
@@ -27,14 +30,14 @@ services:
     image: mongo:4.4
     ports:
       - 27017:27017
-    entrypoint: [ "/usr/bin/mongod", "--bind_ip_all", "--replSet", "steedos" ]
+    command: "--bind_ip_all --replSet steedos --logpath /var/log/mongodb/mongod.log"
     healthcheck:
       test: echo 'db.runCommand("ping").ok' | mongo --quiet | grep 1
       interval: 10s
       timeout: 10s
       retries: 5
     volumes:
-      - 'steedos-mongo-data:/data/db'
+      - './steedos-storage-mongodb:/data/db'
 
   mongodb-init:
     image: mongo:4.4
@@ -44,14 +47,3 @@ services:
         condition: service_healthy
     command: >
       mongo --host mongodb:27017 --eval "rs.initiate({ _id: 'steedos', members: [{_id: 0, host: 'mongodb:27017'}]})"
-
-  # Micro Service Transporter
-  nats:
-    image: bitnami/nats
-    ports:
-      - "4222:4222"
-      - "8222:8222" # monitor port
-
-volumes:
-  steedos-mongo-data:
-    driver: local

package/dist/default/steedos-platform/package.json

@@ -0,0 +1,13 @@
+{
+    "name": "steedos-platform",
+    "version": "1.0.0",
+    "main": "index.js",
+    "license": "MIT",
+    "scripts": {
+      "start": "steedos start"
+    },
+    "dependencies": {
+      "@steedos/service-community": "^2.5"
+    }
+  }
+  

package/dist/default/{steedos.config.js → steedos-platform/steedos.config.js}

@@ -1,5 +1,10 @@
-require('dotenv-flow').config();
+const path = require('path');
+require('dotenv-flow').config({
+	path: path.join(__dirname, '.')
+});
 
+// Moleculer Configuration
+// https://moleculer.services/docs/0.14/configuration.html
 module.exports = {
 	// Namespace of nodes to segment your nodes on the same network.
 	namespace: "steedos",
@@ -7,9 +12,11 @@ module.exports = {
 	// Available values: trace, debug, info, warn, error, fatal
 	logLevel: "warn",
 
+	transporter: process.env.TRANSPORTER,
+
 	// Called after broker started.
 	started(broker) {
 		broker.createService(require("@steedos/service-community"));
-	},
-
+	}
+	
 };