https://github.com/gabrielh-silvestre/todo-list-api

RESTful API with authentication and CRUD operations for an generic Todo-List app.
https://github.com/gabrielh-silvestre/todo-list-api

express mocha-chai-sinon mysql oop prisma restful-api solid typescript

Last synced: 4 days ago
JSON representation

RESTful API with authentication and CRUD operations for an generic Todo-List app.

• Host: GitHub
• URL: https://github.com/gabrielh-silvestre/todo-list-api
• Owner: gabrielh-silvestre
• Created: 2022-03-29T22:28:02.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T13:18:59.000Z (over 2 years ago)
• Last Synced: 2024-12-17T08:14:47.031Z (about 2 months ago)
• Topics: express, mocha-chai-sinon, mysql, oop, prisma, restful-api, solid, typescript
• Language: TypeScript
• Homepage:
• Size: 820 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Todo-List API

A Todo List API é uma aplicação RESTful para a manipulação e leitura de tasks, permitindo operações de CRUD e autenticação via JWT.

## Table de Conteúdos

- [Visão geral](#visão-geral)

  - [O desafio](#o-desafio)

  - [Imagens](#imagens)

  - [Links](#links)

- [Meu processo](#meu-processo)

  - [Construído com](#construído-com)

  - [O que aprendi](#o-que-aprendi)

  - [Recursos úteis](#recursos-úteis)

- [Autor](#autor)

## Visão geral

### O desafio

A Todo List API foi pensada para a prática geral dos conhecimentos sobre uma aplicação em Node.js com Express, cobrindo tópicos como: SOLID, REST, TDD e POO.

__Os usuários devem ser capaz de?__

- Registrar-se e Autenticar-se

- Criar tarefas

- Buscar tarefas

- Atualizar tarefas

- Deletar tarefas

- Consumir a API de qualquer plataforma via HTTP

### Imagens

Documentação da API

![](./assets//todo-list-api-docs.png)

### Links

- URL da documentação: https://todo-list-api-417639.herokuapp.com/v1/api-docs/

## Meu processo

### Construído com

- TypeScript

- Node.js

- Express.js

- Prisma

- Postgres

- Mocha, Chai and Sinon

- Swagger

### O que aprendi

Em um primeiro momento pude praticar o TDD como método de desenvolvimento, consolidar meu conhecimento sobre construção de APIs com Node.js e Express e ainda aprender duas novas ferramentas, o Swagger e o Prisma.

Também utilizei esse projeto para praticar e entender os princípios SOLID, o refatorando e deixando seu código mais limpo, organizado e legível.

### Recursos úteis

- [Artigos pessoais sobre Express](https://dev.to/gabrielhsilvestre/series/17270)

- [Artigos pessoais sobre SOLID e POO](https://dev.to/gabrielhsilvestre/series/18165)

- [Documentação Prisma](https://www.prisma.io/docs/)

## Autor

- LinkedIn - [Gabriel Silvestre](https://www.linkedin.com/in/gabrielh-silvestre/)

- DevTo - [Gabriel_Silvestre](https://dev.to/gabrielhsilvestre)