Doc: add README.md for server. (#12)

* Doc: add README.md for server.

* Fix: typo.

* Fix: typo.

* Fix: move env out.

* Fix: change description.

* Fix: change environment variable name.
This commit is contained in:
Junyi 2020-11-13 22:00:35 +08:00 committed by GitHub
parent 77dc7227a0
commit 92160d0fe5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 63 additions and 2 deletions

View File

@ -0,0 +1,5 @@
NODE_ENV=
DATABASE_URL=postgres://localhost:5432/database
API_BASE_PATH=/api

58
packages/server/README.md Normal file
View File

@ -0,0 +1,58 @@
**Server** 是 NocoBase 的应用服务入口,提供一个可基于 NocoBase 低代码框架启动的应用服务容器。
应用启动后除了拥有基于框架快速提供服务的能力,也可以通过内置的插件机制安装各类插件为应用扩展更多的功能。
快速开始
----------
<!-- TODO: docker 使用方式 -->
### Docker
如果需要直接启动一个无代码应用服务,使用 Docker 是最容易的方式。
~~~shell
docker run nocobase/server
~~~
### Node 应用
~~~shell
npm install @nocobase/server
~~~
在应用入口文件(例如 `server.js`)中:
~~~JavaScript
const Server = require('@nocobase/server');
const app = new Server({
basePath: process.env.BASE_PATH,
database: process.env.DATABASE_URL
});
app.listen(3000); // start http server
~~~
启动应用:
~~~shell
node server.js
~~~
Server 继承自 Koa所以实例也可以作为其他 Koa 应用的中间件使用。
### 深度定制
NocoBase 对开发者是透明的,你可以直接 clone 仓库代码进行更复杂的扩展或定制,以实现特定业务场景的功能。
插件
----------
插件是对 NocoBase 进行扩展的机制,插件通常是一段可执行的代码,在进程启动的时被自动加载(热插拔机制将在未来提供),在加载同时会注入插件可以使用的应用上下文对象,以便对应用进行扩展。
### 加载和初始化
NocoBase 将自动加载以下规则的插件:
<!-- TODO -->

View File

@ -1,4 +1,3 @@
import Database from '@nocobase/database';
import Resourcer, { Action } from '@nocobase/resourcer'; import Resourcer, { Action } from '@nocobase/resourcer';
import actions from '@nocobase/actions'; import actions from '@nocobase/actions';
import Application from './application'; import Application from './application';
@ -53,7 +52,6 @@ export default {
}); });
app.use(middleware({ app.use(middleware({
prefix: '/api',
database: app.database, database: app.database,
resourcer: app.resourcer, resourcer: app.resourcer,
...(options.resourcer||{}), ...(options.resourcer||{}),