https://github.com/michaljalowik/node_boila

Node boilerplate app
https://github.com/michaljalowik/node_boila

ci crud docker docker-compose jest nestjs psql swagger typeorm

Last synced: 5 days ago
JSON representation

Node boilerplate app

• Host: GitHub
• URL: https://github.com/michaljalowik/node_boila
• Owner: MichalJalowik
• Created: 2023-11-15T13:40:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-02T23:21:31.000Z (10 months ago)
• Last Synced: 2024-10-12T09:05:14.794Z (about 1 month ago)
• Topics: ci, crud, docker, docker-compose, jest, nestjs, psql, swagger, typeorm
• Language: TypeScript
• Homepage:
• Size: 521 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456

[circleci-url]: https://circleci.com/gh/nestjs/nest

  
 Node.js boilerplate repo with: NestJs, Rest, GraphQL, TypeORM(Psql), Jest, Docker, Docker-Compose.

    


## Description

[Nest](https://github.com/nestjs/nest) based framework TypeScript starter repository.

## Installation and run

1. npm

```bash

$ npm ci

```

2. build

```bash

$ npm run build

```

3. run api -> from /docker dir

```bash

$ docker-compose up api

```

4. run swagger

```http

localhost:3000/swagger

```

## Migrations

Generate migrations:

1. go into /docker dir

2. go inside api container

```bash

$ docker-compose exec api bash

```

3. run migration:generate command to update db schema

```bash

$ npm run typeorm migration:generate src/migrations/

```

4. you can manually run migrations (migration:run command) but nestjs is set to runs automaticaly

```bash

$ npm run typeorm migration:run

```

## Swagger

Swagger config added to nestJs app

```http

/swagger

```

## Test

from /docker dir

```bash

# unit tests

$ docker-compose run test-runner

```

## License

[MIT licensed](LICENSE).