To Do List API

Projeto criado no módulo 3 de Fullstack: Criação de API para uma To do list.

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

Você instalou a versão mais recente de <Node.Js />.
Você instalou a dependência <express>.
Você instalou a dependência <nodemon>.
Você instalou a dependência <cors>.
Você instalou a dependência <mongoose>.
Você instalou o banco de dados <MongoDB> e o <MongoDB Compass>.

🚀 Instalando `<To do list>`

Para instalar o <To do list>, siga estas etapas:

Windows:

git clone https://github.com/c-Tos1wa/to_do_back.git

Depois de clonado, no terminal do seu VSCode, digite

npm install

para instalar as dependências.

☕ Usando `<To do list>`

Para usar <To do list>, siga estas etapas:

No terminal, digite npm run dev.

Utilizando o Thunder Client, clique em New Request e digite no url https://backend-dolist.herokuapp.com/.

Testando os endpoints:
 * https://backend-dolist.herokuapp.com/ METHOD GET => mostra todas as tarefas listadas no banco de dados.
 * https://backend-dolist.herokuapp.com/:id METHOD GET => mostra uma tarefa específica.
 * https://backend-dolist.herokuapp.com/submit METHOD POST => cadastra uma nova tarefa.
 * https://backend-dolist.herokuapp.com/edit/:id METHOD PUT => altera uma tarefa já cadastrada.
 * https://backend-dolist.herokuapp.com/delete/:id METHOD DELETE => apaga uma tarefa pré-cadastrada.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

_{Cristina Iwassaki}

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo

c-Tos1wa/to_do_back