NestJS REST API boilerplate 🇺🇦

Description

Palo Project: A boilerplate for SaaS applications

Full documentation here

Table of Contents

• Features
• Quick run
• Comfortable development
• Links
• Automatic update of dependencies
• Database utils
• Tests
• Tests in Docker
• Test benchmarking

Features

• Database (typeorm).
• Seeding.
• Config Service (@nestjs/config).
• Mailing (nodemailer).
• Sign in and sign up via email.
• Social sign in (Apple, Facebook, Google, Twitter).
• Admin and User roles.
• I18N (nestjs-i18n).
• File uploads. Support local and Amazon S3 drivers.
• Swagger.
• E2E and units tests.
• Docker.
• CI (Github Actions).

Quick run

cd my-app/
cp env-example .env
docker compose up -d

For check status run

docker compose logs

Comfortable development

cd my-app/
cp env-example .env

Change DATABASE_HOST=postgres to DATABASE_HOST=localhost

Run additional container:

docker compose up -d postgres

npm install

npm run migration:run

npm run seed:run

npm run start:dev

Links

• Swagger: http://localhost:3000/docs

Automatic update of dependencies

If you want to automatically update dependencies, you can connect Renovate for your project.

Database utils

Generate migration

npm run migration:generate -- src/database/migrations/CreateNameTable

Run migration

npm run migration:run

Revert migration

npm run migration:revert

Drop all tables in database

npm run schema:drop

Run seed

npm run seed:run

Tests

# unit tests
npm run test

# e2e tests
npm run test:e2e

Tests in Docker

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