create-steedos-app 3.0.2-beta.11 → 3.0.2-beta.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-steedos-app",
-  "version": "3.0.2-beta.11",
+  "version": "3.0.2-beta.12",
   "keywords": [
     "react",
     "steedos"
@@ -49,5 +49,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "6355c86ba1122cc8e44065d74a010e3e2dfffc9f"
+  "gitHead": "980c6c585aeffd2b82a100bbe6f6e7658fbe10da"
 }

package/templates/default/README.md

@@ -1,31 +1,92 @@
-# Steedos 项目模板
+# Steedos Example App
 
-华炎魔方提供了超越传统无代码平台的深度定制和开发能力，不仅允许没有编程背景的用户快速创建应用，还为有经验的开发人员提供了强大的工具和框架，使他们能够进行更复杂的自定义和集成。
+This is an enterprise-grade low-code/no-code application built on the [Steedos Platform](https://www.steedos.com/).
 
-- [文档](https://docs.steedos.com)
+This project was scaffolded using `create-steedos-app`. It provides a foundation for rapid metadata modeling, API extensions, and business logic development.
 
-# 快速向导
+## 🛠 Prerequisites
 
-## 运行数据库
+Before you begin, ensure you have the following installed in your development environment:
 
-您可以在本地安装 mongodb 和 redis，或者使用 docker 快速启动。
+  - **Node.js**: v22.0 or higher
+  - **MongoDB**: v7.0 or higher
+  - **Redis**: 
+  - **Yarn**
 
-```bash
-docker-compose up mongodb redis
-```
+## 🚀 Quick Start
+
+### 1. Start Db Services
 
+Make sure your MongoDB and Redis services are running. You can start them using the following commands:
 
-## 运行 Steedos
+```bash
+yarn start:db
+```
+### 2. Install Dependencies
 
-### 安装依赖
+Run the following command in the project root to install the required Node packages:
 
 ```bash
+yarn install
 yarn
-yarn build
 ```
 
-### 运行 Steedos
+### 3. Start the Server
+
+Start the development server. Steedos will output the access URL in the console.
 
 ```bash
 yarn start
 ```
+
+### 4. Access the Application
+
+Once the server starts successfully, open your browser and visit:
+`http://localhost:5100` (Default port)
+
+
+## 📂 Project Structure
+
+Here is an overview of the core file structure:
+
+```text
+my-project/
+├── .env                                  # Environment variables (Do not commit sensitive info)
+├── .env.local                            # Local environment overrides
+├── package.json                          # Project dependencies and scripts
+├── steedos-config.js                     # Core Steedos configuration
+├── steedos-packages/example-app/         # Core app directory
+│   ├── main/
+│   │   └── default/
+│   │       ├── objects/                  # Object definitions (Metadata)
+│   │       ├── app/                      # app definitions (Metadata)
+│   └── package.json                      # Business package definition
+```
+
+## ⚙️ Configuration
+
+Create or modify the `.env` file in the project root to configure the database connection and service ports:
+
+```shell
+# Service Port
+PORT=5100
+
+# Database Connection (MongoDB)
+MONGO_URL=mongodb://127.0.0.1:27017/steedos
+
+# Root URL (Important for attachments and API callbacks)
+ROOT_URL=http://localhost:5100
+
+# Metadata Storage Directory
+STEEDOS_STORAGE_DIR=./storage
+```
+
+## 💻 Development Guide
+
+### Exporting Metadata
+
+If you modify configurations via the UI (Steedos Objects), you can sync changes back to your local code using the Steedos command line tools or the VS Code extension.
+## 📚 Resources
+
+  - [Steedos Documentation](https://docs.steedos.com/)
+  - [Steedos GitHub Repository](https://github.com/steedos/steedos-platform)

package/templates/default/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "steedos-project-templates",
+  "name": "steedos-project-template",
   "version": "0.0.1",
   "private": true,
   "workspaces": [

package/templates/default/steedos-packages/example-app/README.md

@@ -0,0 +1,3 @@
+# Steedos Example App
+
+This is an enterprise-grade low-code/no-code application built on the [Steedos Platform](https://www.steedos.com/).

package/templates/default/steedos-packages/example-app/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "steedos-example-app",
+  "version": "0.0.1",
+  "description": "",
+  "main": "package.service.js",
+  "dependencies": {}
+}

package/templates/default/steedos-packages/example-app/package.service.js

@@ -0,0 +1,21 @@
+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: {
+  },
+  events: {
+  }
+}

package/templates/default/steedos-packages/example-service/README.md

@@ -1,19 +0,0 @@
-微服务软件包
-===
-
-可以使用微服务方式扩展化验魔方。
-
-## 启动服务
-
-```sh
-yarn start:services
-```
-
-启动服务之后，为华炎魔方服务扩展了以下API
-
-- hello, 获取当前登录用户: http://127.0.0.1:5000/service/api/example-service/hello/jack
-- me, 获取当前登录用户: http://127.0.0.1:5000/service/api/example-service/me
-
-## 参考
-
-- [Moleculer Nodejs](https://moleculer.services/zh/)

package/templates/default/steedos-packages/example-service/package.json

@@ -1,8 +0,0 @@
-{
-    "name": "my-steedos-service",
-    "version": "0.0.1",
-    "description": "",
-    "main": "package.service.js",
-    "dependencies": {
-    }
-  }

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

@@ -1,88 +0,0 @@
-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 属性。
-          {
-            meta: {
-              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);
-      }
-    }
-  }
-}