nestjs-mtenant - GitLite

KO | EN

gitlite — search

#python #react #golang #machine-learning #rust #docker #windows #awesome #kubernetes #awesome-list #pytorch #ios #openai #open-source

nestjs-mtenant

(★ 150)

NestJS module to enable deep multitenancy support.

파일 탐색기

최종 버전 다운로드 (.zip)

- commit-msg
- pre-commit
- settings.json
- _config.yml
- advanced-usage.md
- api-decorator.md
- configuration.md
- getting-started.md
- index.md
- migration-guide.md
- sequelize.md
- storage.md
- typeorm.md
- - api.spec.ts
  - api.ts
  - constants.spec.ts
  - constants.ts
  - entity.spec.ts
  - entity.ts
- - decorator.error.spec.ts
  - decorator.error.ts
  - mtenant.error.spec.ts
  - mtenant.error.ts
- - core.interface.ts
  - module-async.options.ts
  - module-options.factory.ts
  - module.options.ts
  - storage.interface.ts
- - tenancy.middleware.spec.ts
  - tenancy.middleware.ts
- - tenant-base.repository.spec.ts
  - tenant-base.repository.ts
- - cached.storage.spec.ts
  - cached.storage.ts
  - sequelize.storage.spec.ts
  - sequelize.storage.ts
  - typeorm.storage.spec.ts
  - typeorm.storage.ts
- - tenant-entity.subscriber.spec.ts
  - tenant-entity.subscriber.ts
- - http.transport.spec.ts
  - http.transport.ts
  - transport.interface.ts
- constants.spec.ts
- constants.ts
- helpers.spec.ts
- helpers.ts
- index.ts
- mtenant.module.spec.ts
- mtenant.module.ts
- mtenant.service.spec.ts
- mtenant.service.ts
.commitlintrc.json
.eslintignore
.eslintrc.js
.gitignore
.npmignore
.prettierignore
.prettierrc
CHANGELOG.md
index.d.ts
index.js
index.ts
jest.config.js
LICENSE
package-lock.json
package.json
publish.sh
README.md
renovate.json
tsconfig.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/AlexanderC/nestjs-mtenant

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd nestjs-mtenant

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install nestjs-mtenant nestjs-cls

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm install sequelize sequelize-typescript

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm install typeorm

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm test

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run build

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <a href="http://nestjs.com/" target="blank">
    <img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" />
  </a>
</p>

<p align="center">
  NestJS module for multi-tenancy with deep integration into Sequelize and TypeORM.
</p>

<p align="center">
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/v/nestjs-mtenant.svg" alt="NPM Version" /></a>
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/l/nestjs-mtenant.svg" alt="Package License" /></a>
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/dm/nestjs-mtenant.svg" alt="NPM Downloads" /></a>
</p>

## Features

- Automatic tenant injection into all Sequelize and TypeORM operations
- Header and query parameter based tenant extraction
- Transparent Sequelize hooks (8 hooks covering all CRUD operations)
- TypeORM subscriber for writes + `TenantBaseRepository` for reads
- Pluggable storage (Sequelize, TypeORM) with optional caching (IoRedis)
- Swagger integration via `@MTApi()` decorator
- Per-operation, per-scope, and global tenancy control

## Compatibility

| nestjs-mtenant | NestJS | Node.js | Sequelize | TypeORM |
|:-:|:-:|:-:|:-:|:-:|
| 1.x | 11.x | >= 20 | 6.x | 0.3.x |
| 0.x | 9.x - 10.x | >= 14 | 6.x | - |

## Installation

```sh
npm install nestjs-mtenant nestjs-cls

# For Sequelize support:
npm install sequelize sequelize-typescript

# For TypeORM support:
npm install typeorm
```

## Documentation

Full documentation is available on [GitHub Pages](https://alexanderc.github.io/nestjs-mtenant/).

- [Getting Started](https://alexanderc.github.io/nestjs-mtenant/getting-started)
- [Configuration](https://alexanderc.github.io/nestjs-mtenant/configuration)
- [Sequelize Integration](https://alexanderc.github.io/nestjs-mtenant/sequelize)
- [TypeORM Integration](https://alexanderc.github.io/nestjs-mtenant/typeorm)
- [Storage & Caching](https://alexanderc.github.io/nestjs-mtenant/storage)
- [Swagger Integration](https://alexanderc.github.io/nestjs-mtenant/api-decorator)
- [Advanced Usage](https://alexanderc.github.io/nestjs-mtenant/advanced-usage)
- [Migration Guide (v0.x to v1.0)](https://alexanderc.github.io/nestjs-mtenant/migration-guide)

## Test Coverage

```
Statements : 92.89% (471/507)
Branches   : 97.02% (196/202)
Functions  : 98.27% (114/116)
Lines      : 92.84% (467/503)
```

## Девелопмент

```sh
# Run tests
npm test

# Build
npm run build

# Release
npm run format
npm run release    # or: npm run patch | minor | major
npm run deploy
```

## Contributing

- [Alex Cucer](https://github.com/AlexanderC)

## License

MIT