feat: support MongoDB

.github/workflows/docker-e2e.yml

@@ -12,5 +12,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Run e2e tests
-        run: docker compose -f docker-compose.ci.yaml --env-file env-example -p ci up --build --exit-code-from api
+      - name: Run e2e tests for NestJS with TypeORM
+        run: docker compose -f docker-compose.relational.ci.yaml --env-file env-example-relational -p ci-relational up --build --exit-code-from api
+      - name: Run e2e tests for NestJS with Mongoose
+        run: docker compose -f docker-compose.document.ci.yaml --env-file env-example-document -p ci-document up --build --exit-code-from api

.hygen/seeds/create-document/module.ejs.t

@@ -0,0 +1,21 @@
+---
+to: src/database/seeds/document/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.module.ts
+---
+import { Module } from '@nestjs/common';
+import { MongooseModule } from '@nestjs/mongoose';
+import { <%= name %>Schema, <%= name %>SchemaClass } from 'src/<%= h.inflection.transform(name, ['pluralize', 'underscore', 'dasherize']) %>/entities/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>.schema';
+import { <%= name %>SeedService } from './<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service';
+
+@Module({
+  imports: [
+    MongooseModule.forFeature([
+      {
+        name: <%= name %>SchemaClass.name,
+        schema: <%= name %>Schema,
+      },
+    ]),
+  ],
+  providers: [<%= name %>SeedService],
+  exports: [<%= name %>SeedService],
+})
+export class <%= name %>SeedModule {}

.hygen/seeds/create/run-seed-import.ejs.t → .hygen/seeds/create-document/run-seed-import.ejs.t

@@ -1,6 +1,6 @@
 ---
 inject: true
-to: src/database/seeds/run-seed.ts
+to: src/database/seeds/document/run-seed.ts
 after: \@nestjs\/core
 ---
 import { <%= name %>SeedService } from './<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service';

.hygen/seeds/create/run-seed-service.ejs.t → .hygen/seeds/create-document/run-seed-service.ejs.t

@@ -1,6 +1,6 @@
 ---
 inject: true
-to: src/database/seeds/run-seed.ts
+to: src/database/seeds/document/run-seed.ts
 before: close
 ---
   await app.get(<%= name %>SeedService).run();

.hygen/seeds/create/seed-module-import.ejs.t → .hygen/seeds/create-document/seed-module-import.ejs.t

@@ -1,6 +1,6 @@
 ---
 inject: true
-to: src/database/seeds/seed.module.ts
+to: src/database/seeds/document/seed.module.ts
 before: \@Module
 ---
 import { <%= name %>SeedModule } from './<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.module';

.hygen/seeds/create/seed-module.ejs.t → .hygen/seeds/create-document/seed-module.ejs.t

@@ -1,6 +1,6 @@
 ---
 inject: true
-to: src/database/seeds/seed.module.ts
+to: src/database/seeds/document/seed.module.ts
 after: imports
 ---
     <%= name %>SeedModule,

.hygen/seeds/create-document/service.ejs.t

@@ -0,0 +1,24 @@
+---
+to: src/database/seeds/document/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service.ts
+---
+import { Injectable } from '@nestjs/common';
+import { InjectModel } from '@nestjs/mongoose';
+import { Model } from 'mongoose';
+import { <%= name %>SchemaClass } from 'src/<%= h.inflection.transform(name, ['pluralize', 'underscore', 'dasherize']) %>/entities/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>.schema';
+
+@Injectable()
+export class <%= name %>SeedService {
+  constructor(
+    @InjectModel(<%= name %>SchemaClass.name)
+    private readonly model: Model<<%= name %>SchemaClass>,
+  ) {}
+
+  async run() {
+    const count = await this.model.countDocuments();
+
+    if (count === 0) {
+      const data = new this.model({});
+      await data.save();
+    }
+  }
+}

.hygen/seeds/create/module.ejs.t → .hygen/seeds/create-relational/module.ejs.t

@@ -1,5 +1,5 @@
 ---
-to: src/database/seeds/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.module.ts
+to: src/database/seeds/relational/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.module.ts
 ---
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';

.hygen/seeds/create-relational/run-seed-import.ejs.t

@@ -0,0 +1,6 @@
+---
+inject: true
+to: src/database/seeds/relational/run-seed.ts
+after: \@nestjs\/core
+---
+import { <%= name %>SeedService } from './<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service';

.hygen/seeds/create-relational/run-seed-service.ejs.t

@@ -0,0 +1,6 @@
+---
+inject: true
+to: src/database/seeds/relational/run-seed.ts
+before: close
+---
+  await app.get(<%= name %>SeedService).run();

.hygen/seeds/create-relational/seed-module-import.ejs.t

@@ -0,0 +1,6 @@
+---
+inject: true
+to: src/database/seeds/relational/seed.module.ts
+before: \@Module
+---
+import { <%= name %>SeedModule } from './<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.module';

.hygen/seeds/create-relational/seed-module.ejs.t

@@ -0,0 +1,6 @@
+---
+inject: true
+to: src/database/seeds/relational/seed.module.ts
+after: imports
+---
+    <%= name %>SeedModule,

.hygen/seeds/create/service.ejs.t → .hygen/seeds/create-relational/service.ejs.t

@@ -1,5 +1,5 @@
 ---
-to: src/database/seeds/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service.ts
+to: src/database/seeds/relational/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>/<%= h.inflection.transform(name, ['underscore', 'dasherize']) %>-seed.service.ts
 ---
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';

Dockerfile

@@ -10,13 +10,13 @@ COPY . /usr/src/app
 RUN cp -a /tmp/app/node_modules /usr/src/app
 COPY ./wait-for-it.sh /opt/wait-for-it.sh
 RUN chmod +x /opt/wait-for-it.sh
-COPY ./startup.dev.sh /opt/startup.dev.sh
-RUN chmod +x /opt/startup.dev.sh
+COPY ./startup.relational.dev.sh /opt/startup.relational.dev.sh
+RUN chmod +x /opt/startup.relational.dev.sh
 RUN sed -i 's/\r//g' /opt/wait-for-it.sh
-RUN sed -i 's/\r//g' /opt/startup.dev.sh
+RUN sed -i 's/\r//g' /opt/startup.relational.dev.sh
 
 WORKDIR /usr/src/app
-RUN if [ ! -f .env ]; then cp env-example .env; fi
+RUN if [ ! -f .env ]; then cp env-example-relational .env; fi
 RUN npm run build
 
-CMD ["/opt/startup.dev.sh"]
+CMD ["/opt/startup.relational.dev.sh"]

Procfile

@@ -1,2 +1,2 @@
 web: npm run start:prod
-release: echo '' > .env && npm run migration:run && npm run seed:run
+release: echo '' > .env && npm run migration:run && npm run seed:run:relational

README.md

@@ -20,139 +20,24 @@ Frontend (React, Next.js): <https://github.com/brocoders/extensive-react-boilerp
 ## Table of Contents <!-- omit in toc -->
 
 - [Features](#features)
-- [Quick run](#quick-run)
-- [Comfortable development](#comfortable-development)
-- [Links](#links)
-- [Automatic update of dependencies](#automatic-update-of-dependencies)
-- [Database utils](#database-utils)
-- [Tests](#tests)
-- [Tests in Docker](#tests-in-docker)
-- [Test benchmarking](#test-benchmarking)
 - [Contributors](#contributors)
 
 ## Features
 
-- [x] Database ([typeorm](https://www.npmjs.com/package/typeorm)).
+- [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm) and [Mongoose](https://www.npmjs.com/package/mongoose).
 - [x] Seeding.
 - [x] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
 - [x] Mailing ([nodemailer](https://www.npmjs.com/package/nodemailer)).
 - [x] Sign in and sign up via email.
 - [x] Social sign in (Apple, Facebook, Google, Twitter).
 - [x] Admin and User roles.
-- [x] I18N ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
+- [x] Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
 - [x] File uploads. Support local and Amazon S3 drivers.
 - [x] Swagger.
 - [x] E2E and units tests.
 - [x] Docker.
 - [x] CI (Github Actions).
 
-## Quick run
-
-```bash
-git clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app
-cd my-app/
-cp env-example .env
-docker compose up -d
-```
-
-For check status run
-
-```bash
-docker compose logs
-```
-
-## Comfortable development
-
-```bash
-git clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app
-cd my-app/
-cp env-example .env
-```
-
-Change `DATABASE_HOST=postgres` to `DATABASE_HOST=localhost`
-
-Change `MAIL_HOST=maildev` to `MAIL_HOST=localhost`
-
-Run additional container:
-
-```bash
-docker compose up -d postgres adminer maildev
-```
-
-```bash
-npm install
-
-npm run migration:run
-
-npm run seed:run
-
-npm run start:dev
-```
-
-## Links
-
-- Swagger: <http://localhost:3000/docs>
-- Adminer (client for DB): <http://localhost:8080>
-- Maildev: <http://localhost:1080>
-
-## Automatic update of dependencies
-
-If you want to automatically update dependencies, you can connect [Renovate](https://github.com/marketplace/renovate) for your project.
-
-## Database utils
-
-Generate migration
-
-```bash
-npm run migration:generate -- src/database/migrations/CreateNameTable
-```
-
-Run migration
-
-```bash
-npm run migration:run
-```
-
-Revert migration
-
-```bash
-npm run migration:revert
-```
-
-Drop all tables in database
-
-```bash
-npm run schema:drop
-```
-
-Run seed
-
-```bash
-npm run seed:run
-```
-
-## Tests
-
-```bash
-# unit tests
-npm run test
-
-# e2e tests
-npm run test:e2e
-```
-
-## Tests in Docker
-
-```bash
-docker compose -f docker-compose.ci.yaml --env-file env-example -p ci up --build --exit-code-from api && docker compose -p ci rm -svf
-```
-
-## Test benchmarking
-
-```bash
-docker run --rm jordi/ab -n 100 -c 100 -T application/json -H "Authorization: Bearer USER_TOKEN" -v 2 http://<server_ip>:3000/api/v1/users
-```
-
 ## Contributors
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

docker-compose.document.ci.yaml

@@ -0,0 +1,25 @@
+services:
+  mongo:
+    image: mongo:7.0.3
+    restart: always
+    expose:
+      - 27017
+
+  maildev:
+    build:
+      context: .
+      dockerfile: maildev.Dockerfile
+    expose:
+      - 1080
+      - 1025
+
+  # Uncomment to use redis
+  # redis:
+  #   image: redis:7-alpine
+  #   expose:
+  #     - 6379
+
+  api:
+    build:
+      context: .
+      dockerfile: document.e2e.Dockerfile

docker-compose.document.yaml

@@ -0,0 +1,42 @@
+services:
+  maildev:
+    build:
+      context: .
+      dockerfile: maildev.Dockerfile
+    ports:
+      - ${MAIL_CLIENT_PORT}:1080
+      - ${MAIL_PORT}:1025
+
+  mongo:
+    image: mongo:7.0.3
+    restart: always
+    volumes:
+      - boilerplate-mongo-db:/data/db
+    ports:
+      - 27017:27017
+
+  mongo-express:
+    image: mongo-express
+    restart: always
+    ports:
+      - 8081:8081
+    environment:
+      ME_CONFIG_BASICAUTH_USERNAME: ${DATABASE_USERNAME}
+      ME_CONFIG_BASICAUTH_PASSWORD: ${DATABASE_PASSWORD}
+      ME_CONFIG_MONGODB_URL: mongodb://mongo:27017/
+
+  # Uncomment to use redis
+  # redis:
+  #   image: redis:7-alpine
+  #   ports:
+  #     - 6379:6379
+
+  api:
+    build:
+      context: .
+      dockerfile: document.Dockerfile
+    ports:
+      - ${APP_PORT}:${APP_PORT}
+
+volumes:
+  boilerplate-mongo-db:

docker-compose.ci.yaml → docker-compose.relational.ci.yaml

@@ -1,8 +1,6 @@
 services:
   postgres:
     image: postgres:16.1-alpine
-    volumes:
-      - boilerplate-db:/var/lib/postgresql/data
     expose:
       - 5432
     environment:
@@ -27,8 +25,4 @@ services:
   api:
     build:
       context: .
-      dockerfile: e2e.Dockerfile
-
-
-volumes:
-  boilerplate-db:
+      dockerfile: relational.e2e.Dockerfile

docs/automatic-update-dependencies.md

@@ -0,0 +1,7 @@
+# Automatic update of dependencies
+
+If you want to automatically update dependencies, you can connect [Renovate](https://github.com/marketplace/renovate) for your project.
+
+---
+
+Previous: [Benchmarking](benchmarking.md)