0.0.1 • Published 2 years ago
vkr-first-view v0.0.1
NestJS REST API template
Description
NestJS REST API template for typical project
Table of Contents
Features
- Database (typeorm).
- Seeding (typeorm-seeding).
- Config Service (@nestjs/config).
- Sign in and sign up via email.
- Admin and User roles.
- File uploads with Amazon S3.
- Swagger.
- Docker.
- 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
0.0.1
2 years ago