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

https://github.com/nelsonwenner/nestjs-example

:rocket: Nestjs example
https://github.com/nelsonwenner/nestjs-example

api api-rest backend backend-api docker docker-compose javascript nest nestjs node nodejs npm typeorm typescript

Last synced: 2 months ago
JSON representation

:rocket: Nestjs example

Awesome Lists containing this project

README

          


Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.


## Description

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

### Prerequisites
* Docker Compose version (1.25.4)
* Docker version (19.03.8)
* Node version (12.16.1)
* Npm version (6.14.4)

# Getting Started
1. Fork this repository and clone on your machine
2. Change the directory to `nestjs-example` where you cloned it;
3. At the terminal, run:

```bash
/* Environment variables */

$ cp .env.example .env

/* container up */

$ docker-compose up
```
## Swagger documentation
- Open the host [localhost:3333/api/](http://localhost:3333/api/) and start using it.
---

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

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

## Typeorm cli
```bash
# create file migrate
$ npm run typeorm:cli -- migration:create -n test

# migrate
$ npm run typeorm:cli -- migration:run

# migrate revert
$ npm run typeorm:cli -- migration:revert
```
---