ebagabe / REST-API-todo-list

API REST com TDD utilizando NodeJs com Express, Jest, Supertest e Knex. Além de padrão MVC para organização.

Todo REST API

Este é um exemplo de aplicação RESTful para gerenciar tarefas (todos).

Pré-requisitos

Antes de começar, certifique-se de ter instalado em sua máquina:

• Node.js (v14.x ou superior)
• npm (geralmente vem com o Node.js)
• MySQL / Docker

Configuração

1. Clone este repositório para o seu ambiente local:

por exemplo:

`git clone https://github.com/ebagabe/REST-API-todo-list.git`

2. Navegue até o diretório do projeto:

cd REST-API-todo-list.git

3. Instale as dependências do projeto:

npm install

4. Renomeie o arquivo .env.example para .env e configure as variáveis de ambiente conforme necessário.

Executando a aplicação

Para iniciar o servidor da aplicação, execute o seguinte comando:

npm start

Executando Migrações

Para executar as migrações e criar as tabelas do banco de dados, use o seguinte comando:

knex migrate:latest

4. Desfazendo Migrações

Se você precisar desfazer a última migração executada, use o seguinte comando:

knex migrate:rollback

O servidor será iniciado na porta configurada no arquivo .env.

Testando a API com o Postman

Você pode testar os endpoints da API utilizando o Postman. Para isso, siga os passos abaixo:

1. Faça o download da coleção Postman clicando Aqui.
2. Clique em download no topo do arquivo readme.
3. Abra o Postman e clique em "Import" para importar a coleção.
4. Selecione o arquivo que você baixou e clique em "Open".
5. Agora você terá todos os endpoints disponíveis na sua coleção do Postman. Você pode enviar as requisições e testar a API.