\n\n### Introduction\n\nForest Admin is a low-code SaaS solution that auto-generates an admin panel on top of a data source.\n\n### Requirements\n\n`nestjs-forest` v2 is an **ESM-only** package. It requires:\n\n| Dependency | Version |\n|---|---|\n| NestJS | 12.x |\n| Node.js | >= 20 |\n\nYour own project must therefore be ESM as well: set `\"type\": \"module\"` in your `package.json`, and use `\"module\": \"node16\"` (or later) with a matching `\"moduleResolution\"` in your `tsconfig.json`.\n\n> **Do not use `require('nestjs-forest')`.** On Node 22.12+ it does not throw, but it silently returns a module without `ForestModule` and `ForestService`, so you get `undefined` at the point of use rather than a clear error. Always `import`.\n\nIf you are on NestJS 11 or a CommonJS project, stay on `nestjs-forest` v1:\n\n```bash\n$ npm i --save nestjs-forest@^1.1.15\n```\n\n### Installation\n\nTo start building with Forest Admin on NestJS, first install the required package\n\n```bash\n$ npm i --save nestjs-forest\n```\n\n#### Overview\n\nStart by binding the ForestModule to your AppModule, and give it the configuration payload for the Agent, along with potential data sources to bind\n\n```typescript\nimport { ConfigModule, ConfigService } from '@nestjs/config';\nimport { ForestModule, createSqlDataSource } from 'nestjs-forest';\n\nForestModule.forRootAsync({\n imports: [ConfigModule],\n inject: [ConfigService],\n useFactory: (configService: ConfigService) => ({\n authSecret: configService.get('FOREST_AUTH_SECRET'),\n envSecret: configService.get('FOREST_ENV_SECRET'),\n isProduction: configService.get('ENV') === 'production',\n datasources: [createSqlDataSource(configService.get('DATABASE_URL'))],\n }),\n})\n```\n\nThere is an extra step required by the actual inner Forest Admin Agent implementation.\n\nWe have to bind the agent in the app.ts file\n\n```typescript\nimport { NestFactory } from '@nestjs/core';\nimport { ForestService } from 'nestjs-forest';\n\nimport { AppModule } from './app.module.js';\n\nconst app = await NestFactory.create(AppModule, {});\n\n// Other code...\n\nconst forestService = app.get(ForestService);\nforestService.setApp(app);\n\n// Other code...\n\nawait app.listen(3000, async () => {\n // Start call must be the very last one, to generate the schema file.\n await forestService.start();\n});\n```\n\n#### Usage with dependency injection\n\nOnce everything is set up, you can access the ForestService in your own services\n\n```typescript\nimport { Injectable } from '@nestjs/common';\n\nimport { ForestService } from 'nestjs-forest';\n\n@Injectable()\nexport class AdminService {\n constructor(private readonly _forestService: ForestService) {\n this.customizeCollections();\n }\n\n customizeCollections = () => {\n this._forestService.agent.customizeCollection('companies', (collection) => {\n collection.addAction('Test', {\n scope: 'Single',\n execute: async (ctx, resultBuilder) => {\n console.log('This is my test action');\n return resultBuilder.success('Yes');\n },\n });\n });\n };\n};\n```","readmeFilename":"readme.md"}
![](\"https://assets-global.website-files.com/609bc2f429b6d56efa4a2774/6426f673720545606ebc4c5d_fa-logo-default.svg\"/){kind=logo}
\n