https://github.com/j-hoplin/nestjs-prisma-boilerplate

Nest.js RESTful API Prisma BoilerPlate
https://github.com/j-hoplin/nestjs-prisma-boilerplate

boilerplate-template docker-compose nestjs postgresql prisma typescript

Last synced: 2 months ago
JSON representation

Nest.js RESTful API Prisma BoilerPlate

• Host: GitHub
• URL: https://github.com/j-hoplin/nestjs-prisma-boilerplate
• Owner: J-Hoplin
• Created: 2024-03-17T03:36:05.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-12-02T11:15:37.000Z (2 months ago)
• Last Synced: 2024-12-02T12:22:43.990Z (2 months ago)
• Topics: boilerplate-template, docker-compose, nestjs, postgresql, prisma, typescript
• Language: TypeScript
• Homepage:
• Size: 231 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
## Sentry Init

- Invoke `initializeSentry` from `app.config.ts`

  ```typescript

  async function bootstrap() {

    const app = await NestFactory.create(AppModule, {

      bufferLogs: true,

    });

    initializeSentry(app)

    ...

  }

  ```

- You need to set `SENTRY_DSN` from `.env` file.

- Sentry capture already supported by template exception filter

- This template will set error code as Sentry Error name. If `Unknown` given, It'll set error with this format: `Unknown: (error message)`

  ![img](https://github.com/J-Hoplin/NestJS-Prisma-Boilerplate/assets/45956041/a1c67ecc-aaed-48b0-a848-a79e86ec9d82)

## TODO Left

### Start

```bash

yarn install

yarn prepare

yarn start

```

### Supported Repository Pattern

- Prisma

### Application

- [x] Nest.js Terminus integration

- [ ] Common library(Nest.js library)

  - [ ] S3

  - [ ] SQS

  - [ ] Localstack

- [x] Global Exception Filter

  - [x] Error code definition

- [x] Global Response Interceptor

### Test code

- [ ] Test code boilerplate

  - [ ] E2E test code boilerplate

  - [ ] Unit test code boilerplate

  - [ ] K6 stress test code boilerplate

- [ ] Utilities for test code

  - [ ] `testing-container` utility

  - [ ] Mocking utility

### CI/CD

- [x] Github Actions base script

- [ ] Elastic Beanstalk boiler command and directories(Follos EB standard)