https://github.com/felipe-bp/nestjs-knex

Knex.js module for Nest framework (node.js) ⚙
https://github.com/felipe-bp/nestjs-knex

knex-js knex-query-builder nest nestjs nodejs typescript

Last synced: 25 days ago
JSON representation

Knex.js module for Nest framework (node.js) ⚙

• Host: GitHub
• URL: https://github.com/felipe-bp/nestjs-knex
• Owner: Felipe-BP
• Created: 2020-04-20T02:41:53.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-01-24T12:18:03.000Z (almost 2 years ago)
• Last Synced: 2024-12-15T23:36:02.089Z (25 days ago)
• Topics: knex-js, knex-query-builder, nest, nestjs, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 2.35 MB
• Stars: 16
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        


  

  




  Easy peasy way to integrate Nestjs and Knex.js! 🚀



## Why?

We love [Nestjs](https://nestjs.com/) framework and [Knex.js](http://knexjs.org/) SQL Builder, so, I decided to create this package to abstract the use of Knex.js with Nestjs, which uses TypeScript.

## Installation

To install this generated project:

```bash

$ npm install nestjs-knexjs knex

```

Install the expected client library for your database:

```bash

$ npm install pg

$ npm install sqlite3

$ npm install mysql

$ npm install mysql2

$ npm install oracledb

$ npm install mssql

```

(or yarn equivalent)

## Usage

Check out the [examples](./examples/) folder.

## Contributing

All contributions are welcome. Use the pull request as a way to contribute to the evolution of the package. My intention is over time to add pipelines with github actions as a way to facilitate contributions.

### Contribution Guidelines

This package is configured with [commitlint](https://github.com/conventional-changelog/commitlint), so, to contribute you have to know about the [rules](https://www.conventionalcommits.org/en/v1.0.0/) of commitlint

## Author

- [Felipe Bueno](https://github.com/Felipe-BP)