https://github.com/renanjava/extra-pw-2bim

ESOFT5S-B 2024
https://github.com/renanjava/extra-pw-2bim

Last synced: 18 days ago
JSON representation

ESOFT5S-B 2024

• Host: GitHub
• URL: https://github.com/renanjava/extra-pw-2bim
• Owner: renanjava
• Created: 2024-06-09T19:47:01.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-16T02:32:51.000Z (6 months ago)
• Last Synced: 2024-06-16T03:29:54.352Z (6 months ago)
• Language: TypeScript
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Task Management App with Express

Este é um API construída com **Node.js**, **Typescript**, **Express**, **Prisma**, **Swagger** e **JWT** para gerenciamento de tarefas.

## Entidades

### Tarefa

- Atributos: ID, title, description.

## Inicialização

1. Configure seu ambiente criando um arquivo `.env` (você pode copiar o conteúdo de `.env.example` e colá-lo no novo arquivo).

2. Rode o comando `npm i`.

3. Certifique-se de que o Docker está em execução e execute `npm run setup` no terminal.

4. Para iniciar a aplicação, execute `npm run start`.

5. Para acessar a documentação da API, acesse `http://localhost:3000/api`.

## Acessar banco de dados

É possível verificar os dados salvos no banco através do Terminal do container docker, basta acessar o terminal do container "express-todo-list-db-*" e rodar os comandos:

1. `psql -d taskdb -U admin` para acessar o banco de dados. OBS: devem estar de acordo com o configurado no `.env`

2. `select * from public."Task";` para acessar os dados salvos no banco Task

## Rotas

### Tarefas (Tasks)

- **POST /tasks**

  - Cria uma nova tarefa.

- **GET /tasks**

  - Retorna todas as tarefas.

- **GET /tasks/longest-description**

  - Retorna a tarefa com a maior descrição.

- **GET /tasks/average-conclusion**

  - Retorna a média de conclusão das tarefas.

- **GET /tasks/id**

  - Retorna uma tarefa por ID.

- **PATCH /tasks/id**

  - Atualiza uma tarefa por ID.

- **DELETE /tasks/id**

  - Deleta uma tarefa por ID.