1.1.0 • Published 8 months ago

@paranode/nestjs-typeorm-seeding v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

this package works with @paranode/typeorm-seeding package

Installation

1. install the library using either npm or yarn or your favourite package manager

npm install @paranode/nestjs-typeorm-seeding

2. import SeedingModule into your root module or database module

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { SeedingModule } from '@paranode/nestjs-typeorm-seeding';

@Module({
  imports: [
    TypeOrmModule.forRoot({...}),
    SeedingModule.register({
      seeders: [],
      factories: [],
    })
  ]
})
export class DatabaseModule{}

Optional step:

add these commands to your package.json scripts

{
  ...
  "scripts": {
    ...
    "create:seed": "nest g -c @paranode/nestjs-typeorm-seeding seed",
    "create:factory": "nest g -c @paranode/nestjs-typeorm-seeding factory",
    ...
  }
  ...
}

3. register your seed files and your factory files to the SeederModule.register() function

...
SeedingModule.register({
  seeders: [
    // NOTE: seeders will run the orders they're registered in
    UserSeeder,
    RoleSeeder,
  ],
  factories: [
    UserFactory,
    RoleFactory
  ],
})
...

Example app

you can find a full example application on github here

Contributing

Contributions welcome! open a PR here.

Author

Sayed Mahmoud Github

License

Licensed under the MIT License - see the LICENSE file for details.