| Package | Description | Version |
|---|---|---|
@cisstech/nestjs-expand |
A NestJS module to build Dynamic Resource Expansion for APIs | |
@cisstech/nestjs-pg-pubsub |
Real-time PostgreSQL notifications using PubSub |
Documentation available at https://cisstech.github.io/nestkit/
- Clone and install
git clone https://github.com/cisstech/nestkit
cd nestkit
yarn- For optimal usage with the sample application, set up the following environment variables in a
.envfile in the root of the project:
# PostgreSQL
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=your_database
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/your_database
# Redis (for distributed lock service)
REDIS_HOST=localhost
REDIS_PORT=6379- Start docker
docker-compose up -d- Serve demo
yarn start-
Documentation app will be serve at http://localhost:4200/.
-
Samples APIs documentations will be serve at http://localhost:3000/api/doc.
Contributions are always welcome.
Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.
Please just make sure that ...
Your code style matches with the rest of the project
Unit tests pass
Linter passes
The use of this library is totally free.
As the owner and primary maintainer of this project, I am putting a lot of time and effort beside my job, my family and my private time to bring the best support I can by answering questions, addressing issues and improving the library to provide more and more features over time.
If this project has been useful, that it helped you or your business to save precious time, don't hesitate to give it a star to support its maintenance and future development.
MIT © Mamadou Cisse