Skip to content

Commit 3848374

Browse files
fix: add missing dependency
1 parent fccbbe3 commit 3848374

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
"@nestjs/common": "^7.4.2",
4545
"@nestjs/core": "^7.4.2",
4646
"@types/express-session": "^1.17.0",
47+
"@admin-bro/express": "^3.0.0-beta.3",
4748
"reflect-metadata": "^0.1.13",
4849
"rxjs": "^6.5.3"
4950
}

src/index.ts

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1+
/**
2+
* @module:@admin-bro/nestjs
3+
*
4+
* @description
5+
* This is an official plugin which allows you to render AdminBro in [NestJS
6+
* framework](https://nestjs.com/)
7+
*
8+
* ## Installation
9+
*
10+
* 1. First of all, install the AdminBro along with the module:
11+
*
12+
* ```
13+
* yarn add admin-bro @admin-bro/nestjs
14+
* ```
15+
*
16+
* 2. Once the installation process is complete, we can import the AdminBroModule
17+
* into the root AppModule.
18+
*
19+
* ```
20+
*
21+
*
22+
*
23+
* import { Module } from '@nestjs/common';
24+
* import { AdminModule } from '@admin-bro/nestjs';
25+
*
26+
* @Module({
27+
* imports: [
28+
* AdminModule.createAdminModule({
29+
* // module options
30+
* }),
31+
* ],
32+
* })
33+
* export class AppModule {}
34+
* ```
35+
*/
36+
137
import * as NestJSPlugin from './admin.module'
238

339
export * from './admin.module';

0 commit comments

Comments
 (0)