Nestjs Admin

Overview:

NestJS Admin is a user interface designed for administrative tasks, allowing users to manage entities through features like listing, editing, creating, and deleting. Inspired by Django admin, this tool is a work in progress with an unstable API. Users can add NestJS Admin to their project dependencies to access the interface and manage entities conveniently.

Features:

• User Interface: Provides a ready-to-use interface for managing administrative activities.
• Entity Management: Allows users to list, edit, create, and delete entities with ease.
• Inspired by Django Admin: Heavily influenced by Django admin from concept to API design.
• Entity Registration: Users can register entities within the admin site for easy access.
• Compatibility: Compatible with various libraries like @nestjs/common, @nestjs/core, @nestjs/platform-express, @nestjs/typeorm, and typeorm.
• Contributions Welcome: Open to contributions for implementing new features inspired by Django Admin.
• Example App: Includes an example application to demonstrate the usage of NestJS Admin.

Installation:

1. Add NestJS Admin to your dependencies:

   npm install nestjs-admin
   

2. Add DefaultAdminModule to your app modules:

   import { DefaultAdminModule } from 'nestjs-admin';
   
   @Module({
     imports: [
       DefaultAdminModule,
     ],
   })
   export class AppModule {}
   

3. Add AdminUser to your ORM config:

   import { AdminUser } from 'nestjs-admin';
   
   const ormConfig = {
     entities: [AdminUser],
     // Other ORM configurations
   };
   

4. Create your first AdminUser to log in and access the admin interface.

Summary:

NestJS Admin is a tool that simplifies administrative tasks by providing a user interface for managing entities. It is inspired by Django admin and offers features like entity management and entity registration. Users can contribute to the project, use the provided compatibility information, and explore the example app to get started with NestJS Admin.