c80f78594e
The HandlebarsAdapter reads partials config from a top-level sibling of
`template` (mailerOptions.options.partials), not from
template.options.partials where it was nested. Because the mail templates
use partial blocks ({{#> layout}}...{{/layout}}), the unregistered partial
rendered silently as an unstyled fragment instead of throwing, so this went
unnoticed. A config-only fix also breaks on Windows because the adapter's
glob-based directory loader mishandles backslash path separators.
Fix registers the shared `layout` partial directly on the handlebars module
singleton in MailConfigService, bypassing the broken glob loader entirely.
Also:
- add mail-config.service.spec.ts, an integration test that drives the real
MailerOptions + HandlebarsAdapter wiring (would have caught this bug,
unlike the existing template-only spec which registers the partial itself)
- remove stale nestjs-i18n references from .env.example, env-example, and
the backend README (i18n was already removed from the code)
- add missing trailing newlines to activation.hbs and reset-password.hbs
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
141 lines
2.7 KiB
Markdown
141 lines
2.7 KiB
Markdown
# PROD System
|
|
Datenbank auf Server: teamwallet
|
|
|
|
# NestJS REST API boilerplate 🇺🇦
|
|
`ssh -L 3306:127.0.0.1:3306 bastian@h2979752.stratoserver.net`
|
|
## Description
|
|
|
|
Seeden: npm run seed:run
|
|
|
|
## Table of Contents
|
|
|
|
- [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)
|
|
|
|
## Features
|
|
|
|
- [x] Database ([typeorm](https://www.npmjs.com/package/typeorm)).
|
|
- [x] Seeding.
|
|
- [x] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
|
|
- [x] Mailing ([nodemailer](https://www.npmjs.com/package/nodemailer), [@nestjs-modules/mailer](https://www.npmjs.com/package/@nestjs-modules/mailer)).
|
|
- [x] Sign in and sign up via email.
|
|
- [x] Social sign in (Apple, Facebook, Google, Twitter).
|
|
- [x] Admin and User roles.
|
|
- [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 redis
|
|
```
|
|
|
|
```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
|
|
```
|