https://github.com/luc-ribeiro/todo-api-node

A Todo API list built with Node.js, TypeScript, Sequelize and Express.
https://github.com/luc-ribeiro/todo-api-node

express nodejs postgresql sequelize typescript

Last synced: 3 months ago
JSON representation

A Todo API list built with Node.js, TypeScript, Sequelize and Express.

• Host: GitHub
• URL: https://github.com/luc-ribeiro/todo-api-node
• Owner: luc-ribeiro
• Created: 2021-11-29T12:54:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T02:12:59.000Z (about 2 years ago)
• Last Synced: 2025-10-06T01:56:54.811Z (9 months ago)
• Topics: express, nodejs, postgresql, sequelize, typescript
• Language: TypeScript
• Homepage:
• Size: 1.1 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-PTBR.md

Awesome Lists containing this project

README

          


To do list API








  Clique aqui para ver a versão em Português.



## 💻 Projeto

O projeto consiste em uma API REST para cadastro, leitura, alteração e deleção de "To dos".

## 🚀 Tecnologias

- **Node.js** 

- **Express**

- **TypeScript**

- **PostgreSQL**

- **Sequelize**

### 🔖 Preview

![preview](https://github.com/luc-ribeiro/nodets-todo-api/blob/master/design/preview.gif)

#### Tabela do Banco de Dados

![banner](https://github.com/luc-ribeiro/nodets-todo-api/blob/master/design/bd-preview.png)




## :page_facing_up: Como utilizar

Faça um clone deste repositório:

```sh

  $ git clone https://github.com/luc-ribeiro/nodets-todo-api.git

```

Instale as dependências:

```sh

  # com npm

  $ npm install

  # com yarn

  $ yarn install

```

Criar um arquivo `.env` na raiz do projeto 



Nesse arquivo, definir as seguintes configurações:

```sh

PORT=NúmeroDaPortaQueAAplicaçãoIráRodar

PG_DB=NomeDoBancoDeDados

PG_USER=NomeDoUsuárioDoBancoDeDados

PG_PASSWORD=SenhaDoUsuário

PG_PORT=NúmeroDaPortaDoBancoDeDados

```

Criar uma tabela no Banco de Dados com o nome `todos`

Execute o comando:

```sh

  # com npm

  $ npm run start-dev

  # com yarn

  $ yarn start-dev

```




### Utilizando as rotas

Após definir o número da porta no arquivo `.env`:

`GET` `localhost:NumeroDaPorta/todo` → Irá lista os To Dos cadastrados no Banco de Dados. 



`POST` `localhost:NumeroDaPorta/todo` → Irá cadastrar um To Do, é necessário informar no Body da requisição o `title`, que será o nome do To Do.



`PUT` `localhost:NumeroDaPorta/todo/:id` → Irá atualizar o To Do com o ID informado. Necessário informar o `title` no Body da requisição. 



`DELETE` `localhost:NumeroDaPorta/todo/:id` → Irá deletar o To Do com o ID informado.