飞牛快速脚手架：如何快速制作一个飞牛App

应用目录与文件说明#

cmd/ 目录下的生命周期脚本说明#

Manifest#

这是描述应用包，不包含扩展名。 只显示在飞牛 app 上的应用名称和描述。

应用权限#

权限配置文件位于config/privilege

生命周期脚本或访问包用户无法处理的设备除外。不要将run-as设置为特权用户Root

文件访问#

配置文件为config/resource，应用默认不会获得用户文件的广泛访问权限。需要读取或写入用户数据时，应由用户明确授权目录访问。

这段需要分两部分：

1
{
2
  "data-share": {
3
    "shares": [
4
      {
5
        "name": "myapp/documents"
6
      },
7
      {
8
        "name": "myapp/backups"
9
      }
10
    ]
11
  }
12
}

1
{
2
  "data-share": {
3
    "shares": [
4
      {
5
        "name": "myapp/documents",
6
        "permission": {
7
          "rw": ["other_app_user"],
8
          "ro": ["report_reader"]
9
        }
10
      }
11
    ]
12
  }
13
}

1
{
2
  "docker-project": {
3
    "projects": [
4
      {
5
        "name": "myapp-stack",
6
        "path": "docker"
7
      }
8
    ]
9
  }
10
}

应用入口#

配置文件为 app/ui/config（当 Manifest 中指定 desktop_uidir=ui 时）。应用入口定义了用户从飞牛 fnOS 打开应用的方式，常用于注册桌面图标及文件右键打开方式。入口 ID 建议统一加上应用前缀（如 myapp.main）。

根据用户交互场景的不同，入口配置分为以下两种主要形式：

1
{
2
  ".url": {
3
    "myapp.main": {
4
      "title": "My App",
5
      "icon": "images/icon_{0}.png",
6
      "type": "iframe",
7
      "protocol": "http",
8
      "port": "8080",
9
      "url": "/",
10
      "allUsers": true
11
    }
12
  }
13
}

用户向导#

所有关于向导的文件将会保存在wizard目录中。其中包括install、uninstall、upgrade、config，他们通用以下json结构

1
[
2
  {
3
    "stepTitle": "Setup",
4
    "items": [
5
      {
6
        "type": "text",
7
        "field": "wizard_username",
8
        "label": "Username",
9
        "initValue": "admin",
10
        "rules": [
11
          {
12
            "required": true,
13
            "message": "Enter a username"
14
          }
15
        ]
16
      }
17
    ]
18
  }
19
]

wizard_username将会作为环境变量。

项目对应依赖#

若应用需要依赖，可在manifest中申明依赖install_dep_apps，同时可作嵌套依赖。

1
install_dep_apps=database:cache

同时若需要关系数据库、运行时环境，也可使用install_dep_apps=redis。

如果用到了运行时环境，请加入对应的PATH。

1
export PATH=/var/apps/{environment}/target/bin:$PATH

应用图标#

需另外图标文件 ICON.PNG: 64 x 64 px ICON_256.PNG：256 x 256 px

• 格式：PNG 或 JPG
• 色彩空间：sRGB
• 文件大小：不超过 1024 KB
• 画布：完整正方形图片
• 圆角：图标视觉主体应使用圆角矩形风格。不要使用直角满铺的方形主体；圆角、留白和阴影应尽量与系统图标保持一致。

放置于app/ui/images/下。