\n\n \n\n---\n\n## Description\n\nReady-to-use user interface for administrative activities. Allows to list, edit, create, delete entities.\n\nThis is heavily, heavily inspired by [Django admin](https://djangobook.com/mdj2-django-admin/), from the concept to the API.\n\n> This is still very much a work in progress.\n> Your help is more than welcome!\n\n**Full docs: https://nestjs-admin.com/**\n\n| | |\n:-------------------------:|:-------------------------:\n | \n_All your entities in one place._ | _Create, update and delete entities with ease._\n\n\n## Installation\n\nLet's get you started with a minimal setup.\n\n1. **Add nestjs-admin to your dependencies:**\n\n```bash\nyarn add nestjs-admin # With yarn\nnpm install nestjs-admin # With NPM\n```\n\n2. **Then add the provided `DefaultAdminModule` to your app modules:**\n\n```ts\n// src/app.module.ts\nimport { Module } from '@nestjs/common'\nimport { DefaultAdminModule } from 'nestjs-admin'\n\n@Module({\n imports: [TypeOrmModule.forRoot(), /* ... */, DefaultAdminModule],\n /* ... */,\n})\nexport class AppModule {\n /* ... */\n}\n```\n\n3. **Add the provided `AdminUser` to your orm config:**\n\nThe DefaultAdminModule exposes an AdminUser entity, which has credentials that allow you to login to the admin interface.\n\n> There's no easy option to use your own user entity for now. If you have this requirement, open an issue so that we can help you.\n\n```ts\n// If you use an ormconfig.js\nconst AdminUser = require('nestjs-admin').AdminUserEntity\nmodule.exports = {\n /* ... */,\n entities: [/* ... */, AdminUser],\n // Alternatively:\n // entities: [/* ... */, 'node_modules/nestjs-admin/**/*.entity.js'],\n}\n```\n\n```bash\n# If you use environment variables\nTYPEORM_ENTITIES=your_existing_paths,node_modules/nestjs-admin/**/*.entity.js\n```\n\n4. **Create a first AdminUser to log in with**\n\n```bash\n# Create the AdminUser schema in database\nnpx ts-node node_modules/.bin/typeorm migration:generate -n \"create-admin-user\"\nnpx ts-node node_modules/.bin/typeorm migration:run\n\n# Now you can create an AdminUser through the CLI\nnpx nestjs-admin createAdminUser\n```\n\n> You can create AdminUsers from the `nestjs-admin createAdminUser` CLI, or directly from the administration interface!\n\nYou can now login to access the admin interface at `/admin/login`!\n\n5. **Register entities in the admin site**\n\n```ts\n// user.module.ts\nimport { TypeOrmModule } from '@nestjs/typeorm'\nimport { Module } from '@nestjs/common'\nimport { DefaultAdminModule, DefaultAdminSite } from 'nestjs-admin'\nimport { User } from './user.entity'\n\n@Module({\n imports: [TypeOrmModule.forFeature([User]), DefaultAdminModule],\n exports: [TypeOrmModule],\n})\nexport class UserModule {\n constructor(private readonly adminSite: DefaultAdminSite) {\n // Register the User entity under the \"User\" section\n adminSite.register('User', User)\n }\n}\n```\n\nCheck the [rest of the docs](./docs) for more details.\n\n## Compatibility\n\n| Library | Version |\n| ------------------------ | ------- |\n| @nestjs/common | ^6.0.0 |\n| @nestjs/core | ^6.0.0 |\n| @nestjs/platform-express | ^6.0.0 |\n| @nestjs/typeorm | ^6.0.0 |\n| typeorm | ^0.2.12 |\n\n## Contributing\n\nAny contribution is welcome. If you want to implement a feature, you need to know that we are following [django-admin's API](https://docs.djangoproject.com/en/2.2/ref/contrib/admin/) as closely as possible. Why?\n\n- It's been well-thought-out by smart people\n- Python translates well to Typescript\n- It allows us to not have to think about what the API should look like and just use Django admin as a list of desirable features\n\n### Start the example app\n\nThis repo contains an example of how to use nestjs-admin. Here's how to use it:\n\n```bash\n# In a first terminal, run the database\ncp .env.example .env\ndocker-compose up\n\n# In a second terminal, compile the library\nyarn install\nyarn link\nyarn start:dev\n\n# In a third terminal, run the example app\ncd exampleApp/\nyarn install\nyarn link nestjs-admin\nyarn migration:run\nyarn start:debug\n```\n\nYou can now create an AdminUser (`yarn nestjs-admin createAdminUser`) to be able to login to `localhost:8000/admin`.\n\nThe code for the actual library is in `libs/nestjs-admin`.\n\n### Tooling\n\nIf you use VSCode, a `.vscode/` is committed that contains a good configuration to contribute. In particular, it contains a config for a ready-to-use debugger.\n\n### ADRs\n\nYou'll find [ADRs](https://github.com/joelparkerhenderson/architecture_decision_record#suggestions-for-writing-good-adrs) in `docs/adr`\n","readmeFilename":"README.md"}
![\"NPM](\"https://img.shields.io/npm/v/nestjs-admin.svg\")
\n \n![\"Theodo](\"./docs/assets/theodo.svg\")
\n