https://github.com/rodrigokamada/tdc-future-2022-nodejs-api-rest

Repositório utilizado no evento TDC Future 2022 com o tema "API REST em Node.js: Boas práticas em produção".
https://github.com/rodrigokamada/tdc-future-2022-nodejs-api-rest

api eslint expressjs mongodb nodejs openapi rest swagger tdc thedevconf typescript

Last synced: 5 days ago
JSON representation

Repositório utilizado no evento TDC Future 2022 com o tema "API REST em Node.js: Boas práticas em produção".

• Host: GitHub
• URL: https://github.com/rodrigokamada/tdc-future-2022-nodejs-api-rest
• Owner: rodrigokamada
• License: mit
• Created: 2022-12-07T14:08:55.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-22T22:39:18.000Z (about 2 years ago)
• Last Synced: 2025-01-13T07:37:41.630Z (12 days ago)
• Topics: api, eslint, expressjs, mongodb, nodejs, openapi, rest, swagger, tdc, thedevconf, typescript
• Language: TypeScript
• Homepage:
• Size: 82 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# TDC Business SP 2022

Repositório utilizado no evento TDC Business com o tema _API REST em Node.js: Boas práticas em produção_.

[![Website](https://shields.braskam.com/v1/shields?name=website&format=rectangle&size=small&radius=5)](https://rodrigo.kamada.com.br)

[![LinkedIn](https://shields.braskam.com/v1/shields?name=linkedin&format=rectangle&size=small&radius=5)](https://www.linkedin.com/in/rodrigokamada)

[![Twitter](https://shields.braskam.com/v1/shields?name=twitter&format=rectangle&size=small&radius=5&socialAccount=rodrigokamada)](https://twitter.com/rodrigokamada)

[![Instagram](https://shields.braskam.com/v1/shields?name=instagram&format=rectangle&size=small&radius=5)](https://www.instagram.com/rodrigokamada/)

## Pré-requisitos

* [git](https://git-scm.com/)

* [Node.js e npm](https://nodejs.org/)

* IDE (por exemplo [Visual Studio Code](https://code.visualstudio.com/)

* [Docker e Docker Compose](https://www.docker.com/)

## Início

**1.** Clonar o repositório.

```shell

git clone [email protected]:rodrigokamada/tdc-future-2022-nodejs-api-rest.git

```

**2.** Instalar as dependências.

```shell

npm install

```

**3.** Executar o lint.

```shell

npm run lint

```

**4.** Executar a aplicação usando o [Nodemon](https://nodemon.io/).

```shell

npm run start:dev

```

## Testes

### Testes automáticos

**1.** Executar os testes.

```shell

npm test

```

### Testes manuais

**1.** Fazer uma requisição na aplicação para listar os livros.

```shell

curl -v "http://localhost:3000/v1/books"

```

**2.** Fazer uma requisição na aplicação para criar um livro.

```shell

curl -v -X POST "http://localhost:3000/v1/books" \

-H "content-type: application/json" \

-d '{

  "title": "Some title",

  "author": "Some author"

}'

```

**3.** Fazer uma requisição na aplicação para alterar um livro.

```shell

curl -v -X PUT "http://localhost:3000/v1/books/ID" \

-H "content-type: application/json" \

-d '{

  "title": "Some title 2",

  "author": "Some author 2"

}'

```

**4.** Fazer uma requisição na aplicação para apagar um livro.

```shell

curl -v -X DELETE "http://localhost:3000/v1/books/ID"

```

## Transpilação

**1.** Compilar/transpilar a aplicação.

```shell

npm run build

```

## Execução

**1.** Executar a aplicação.

```shell

npm start

```

## Execução com o Nodemon

**1.** Executar a aplicação.

```shell

npm run start:dev

```