Api
Description
Backend API build with Nest Framework.
This project uses @nestjsx/crud to simplify and standardize the REST API
Built with
Component | Using | Descrption |
Base | ||
ORM | ||
CRUD | ||
File Upload | ||
Validation | ||
Documentation | ||
Authentication | ||
Testing | ||
Code Style |
Development
Run
Postgres
start Postgres
if error
The container name "/postgres" is already in use by container
, remove orphan container.
connect Postgres running on local k8s
Run Dev Mode
Run Prod Mode
API URL: http://localhost:3000
Swagger Docs URL: http://localhost:3000/docs
Build
build for production env
Commands
Generate
scaffolding nest artifacts For more details checkout playbook
Unit Test
coverage will be generate in coverage/apps/api
E2E Test
Health
check API App health
https://api.kashmora.com/live https://api.kashmora.com/ready
Reference
Awesome Nest
NestJS Samples
TypeORL Samples
Last updated