Expressa 项目安装与使用教程

1. 项目目录结构及介绍

Expressa 项目的目录结构如下：

myapp/
├── node_modules/
├── data/
│   ├── settings/
│   ├── role/
│   └── collection/
├── app.js
├── package.json
└── package-lock.json

目录结构介绍

• node_modules/: 存放项目依赖的 Node.js 模块。
• data/: 存放项目的配置文件和数据。
  • settings/: 配置文件，包含每个环境的设置，可以包含自定义变量。
  • role/: 权限系统的角色列表，默认包含 "Admin"、"Anonymous" 和 "Authenticated"。
  • collection/: 每个集合的 JSON Schema 和设置。
• app.js: 项目的启动文件。
• package.json: 项目的依赖和脚本配置文件。
• package-lock.json: 锁定项目依赖版本的文件。

2. 项目启动文件介绍

项目的启动文件是 app.js，以下是该文件的基本内容：

var express = require('express');
var app = express();
var expressa = require('expressa');

app.use('/admin', expressa.admin({ apiurl: '/api/' }));
app.use('/api', expressa.api());

app.listen(3000, function () {
  console.log('Example app listening on port 3000');
});

启动文件介绍

• express: 引入 Express 框架。
• expressa: 引入 Expressa 中间件。
• app.use('/admin', expressa.admin({ apiurl: '/api/' })): 挂载 Expressa 的管理界面。
• app.use('/api', expressa.api()): 挂载 Expressa 的 API 接口。
• app.listen(3000, function () {...}): 启动服务器，监听 3000 端口。

3. 项目配置文件介绍

项目的配置文件主要存放在 data/ 目录下，具体包括：

settings/

• 配置文件: 每个环境的配置文件，可以包含自定义变量。

role/

• 角色列表: 权限系统的角色列表，默认包含 "Admin"、"Anonymous" 和 "Authenticated"。

collection/

• 集合配置: 每个集合的 JSON Schema 和设置。

配置文件介绍

• settings/: 配置文件通常用于定义不同环境的变量，例如数据库连接信息、API 密钥等。
• role/: 角色列表文件定义了系统中的用户角色，每个角色可以有不同的权限。
• collection/: 集合配置文件定义了每个集合的结构和行为，可以通过管理界面进行编辑。

通过以上配置文件，可以灵活地管理和扩展 Expressa 项目。