Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rvansant2/nestjs-postgres-starter-kit

NestJs framework TypeScript starter kit with Docker
https://github.com/rvansant2/nestjs-postgres-starter-kit

nestjs nodejs typeorm typescript

Last synced: 4 days ago
JSON representation

NestJs framework TypeScript starter kit with Docker

Awesome Lists containing this project

README

        

# nestjs-postgres-starter-kit


Nest Logo

## Description

[Nest](https://github.com/nestjs/nest) framework TypeScript starter kit with Docker.

## Requirements

- Docker Desktop
- NodeJs v^14.6.x (optional)
- npm v^6.14.x (optional)

## Get Started

- Clone repo and change directory into the project: `nestjs-postgres-starter-kit`
- Run `docker-compose up -d --build`, the `-d` is an optional command if you wish to watch logs.

## Local Installation

```bash
$ npm install
```

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

## Test Commands

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```

## License

Nest is [MIT licensed](LICENSE).

## Todos

- Add additional tests
- Add multi-stage Docker build for production
- Update `docker-compose` file for production