vkr-first-view

NestJS REST API template

Description

NestJS REST API template for typical project

Table of Contents

• Features
• Quick run
• Comfortable development
• Links
• Database utils

Features

• [x] Database (typeorm).
• [x] Seeding (typeorm-seeding).
• [x] Config Service (@nestjs/config).
• [x] Sign in and sign up via email.
• [x] Admin and User roles.
• [x] File uploads with Amazon S3.
• [x] Swagger.
• [x] Docker.
• [x] GitLab CI

Quick run

git clone --depth 1 https://github.com/khodorkovskyalexey/vkr-first-view.git my-app
cd my-app/
cp env-example .env

Change DB_HOST=127.0.0.1 to DATABASE_HOST=postgres

docker-compose up -d

For check status run

docker-compose logs

Comfortable development

git clone --depth 1 https://github.com/khodorkovskyalexey/vkr-first-view.git my-app
cd my-app/
cp env-example .env

Run additional container:

docker-compose up -d postgres adminer redis

yarn install
yarn migration
yarn seeds
yarn start:dev

Links

• Swagger: http://localhost:5000/api
• Adminer (client for DB): http://localhost:8080

Database utils

Generate migration

yarn migration:generate CreatingMigrationName

Run migration

yarn migration

Revert migration

yarn migration:revert

Sync all tables in database

yarn schema:sync

Drop all tables in database

yarn schema:drop

Run seeds

yarn seeds

Stay in touch

Author - Alexey Khodorkovsky

License

MIT license.