管理员- mikroorm
安装
线条
$ yarn add @adminjs/mikroorm
无
$ npm i @adminjs/mikroorm
使用量
插件可以使用标准注册 AdminJS.registerAdapter 方法.
import { Database, Resource } from '@adminjs/mikroorm';
import AdminJS from 'adminjs';
import { validate } from 'class-validator';
const setupAdminJs = async () => {
const orm = await MikroORM.init({
entities: [User],
dbName: process.env.DATABASE_NAME,
type: 'postgresql',
clientUrl: process.env.DATABASE_URL,
});
// If your entities use `class-validator` to validate data, you can inject it's validate method into the resource.
Resource.validate = validate;
AdminJS.registerAdapter({ Database, Resource });
// You can instantiate AdminJS either by specifying all resources separately:
const adminJs = new AdminJS({
resources: [{ resource: { model: User, orm }, options: {} }],
});
// Or by passing your ORM instance into `databases` property.
const adminJs = new AdminJS({
databases: [orm],
});
// You should choose to use either `resources` or `databases`
};
示例
示例项目可见于 example-app 目录.
协会
目前仅 ManyToOne 财务报告和审定财务报表 OneToOne 由于当前AdminJS的核心局限性,关系得到了支持
用于适配器集成. OneToMany 财务报告和审定财务报表 ManyToMany 关系仍然可以通过自定义组件和钩子的结合来实现.
捐款
运行示例应用程序
如果您想要在本地设置此程序, 这就是建议的过程 :
- 叉出还原
- 安装依赖关系
yarn install
- 将此软件包注册为 链接软件包
yarn link
- 设置示例应用程序
安装所有依赖和使用先前链接的版本 @adminjs/mikroorm。 。 。 .
cd example-app
yarn install
yarn link "@adminjs/mikroorm"
可以选择,您可能想要链接您的本地版本 adminjs 软件包
-
确定您已设置了所有嵌入器( 见
./example-app/example.env创建.env基于此文件) -
以监视模式构建软件包
(在根文件夹中)
yarn dev
- 在 dev 模式下运行应用程序
cd example-app
yarn dev
调取请求
在你做公关之前 确定所有的测试都通过 并且代码不会引起错误. 你可以通过运行来做到这一点:
yarn lint
yarn test
确定你有一个 .env 在工程的根目录中用于测试运行器的文件 :
DATABASE_URL=postgres://postgres:@localhost:5433/mikroorm_test
DATABASE_NAME=mikroorm_test
许可证
AdminJS拥有2023rst.software的版权. 它是一种自由软件,可按下列规定重新分配: 自由主义 文档.
关于 rst. 软件
我们是一个开放、友好的团队.