engageable-nestjs
v1.0.2
Published
An engagement library/plugin for adding engagement (likes, comments, reviews/ratings, reposts, bookmarks, etc.) to entities in a NestJS application.
Downloads
18
Maintainers
Readme
Engageable for NestJS
Engageable is a powerful, plug-and-play NestJS engagement module that adds social interaction features like likes, comments, review/rating, bookmarks, reposts, and more — to any entity in your application.
Built with TypeORM and NestJS best practices, engageable makes it easy to add engagement functionality across your project with minimal setup.
Features
- ✅ Drop-in Engagement System — Easily attach likes, comments, review/rating, bookmarks, reposts, etc to any entity.
- ✅ Modular NestJS Plugin — Import as a Nest module or apply via decorators.
- ✅ TypeORM Ready — Works seamlessly with your existing TypeORM entities.
- ✅ Extensible Design — Add your own custom engagement types.
- ✅ Lightweight & Scalable — Built for production-ready APIs.
Installation
# with npm
npm install engageable-nestjs
# or with yarn
yarn add engageable-nestjs
npm install @nestjs/common @nestjs/core @nestjs/typeorm typeormRegistration of the module
import { Module } from "@nestjs/common";
import { TypeOrmModule } from "@nestjs/typeorm";
import { engageableModule } from "engageable-nestjs";
@Module({
imports: [
TypeOrmModule.forRoot({
/* ...database config... */
}),
engageableModule.register(),
],
})
export class AppModule {}Usage
import { Entity, Column } from "typeorm";
import { Engageable } from "engageable-nestjs";
@Entity()
@Engageable()
export class Post {
@Column()
title: string;
@Column()
content: string;
}More Usage Documentation
https://github.com/IsaiahTek/engageable-nestjs/blob/main/README.md
