jcatabriga / nest-seed

Shoulders: Nest Seed

A smart organization that aims to facilitate the understanding of complexity

A progressive Node.js framework for building efficient and scalable server-side applications.

---

Description

🚀 This ia a seed to start a Nest application easily with useful features already configured!

---

Our Features:

• Security:
  • CORS
  • Helmet
  • Rate Limiting
• Facilitators
  • eslint and prettier configured
  • Prisma Configured
  • Docker Compose with PostgresSQL to development
• Features
  • Pipe to modify numeric request queries
  • Timeout interceptor
  • Docs with Swagger
  • Validation with class validators
  • Useful DTOs to filter requests
  • Cookies
• Resources
  • Users
  • Roles
  • Contacts

Working on:

• Authorization and authentication with CASL
  • Auth decorator that group auth logical

Future:

• Security:
  • CSRF Protection
• Features
  • Logging
  • File Upload

Analyzing:

• GraphQL Branch
• Websocket Branch
• Microservice (gRPC) Branch

---

Installation

$ yarn install

Start database

$ docker-compose up -d

Run Migrations

# You can edit prisma/schema.prisma before run (optional)
$ npx prisma migrate dev

Running the app

# development
$ yarn start

# watch mode
$ yarn dev

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

---

Import Insomnia

If you use the insomnia to test your requests we have prepared a configured file to start testing our API.

---

Swagger

To view the documentation just access http://localhost:3000/api while the project is running

You can edit this URL configuration at file config/app.ts

---

Support

More info soon

License

Nest is MIT licensed.