Projeto ToDoList com Spring Boot e React com TypeScript

Este é um projeto de uma aplicação Todo List desenvolvida utilizando Spring Boot no backend e React com TypeScript no frontend. A aplicação permite ao usuário criar, visualizar, atualizar e excluir tarefas de listas.

Pré-requisitos

Antes de executar o projeto, certifique-se de ter as seguintes ferramentas instaladas em seu ambiente de desenvolvimento:

Java Development Kit (JDK) 17 ou superior
Git

Para rodar o projeto execute:

docker compose up -d

Após isso o backend estará sendo executado na porta 8080 e o frontend será acessível na porta 5173. Você poderá acessar a aplicação no seu navegador através do endereço http://localhost:5173.

Uso

Ao acessar a aplicação, você poderá visualizar as listas de tarefas existentes, adicionar novas tarefas e excluí-las.

Estrutura do Projeto

O projeto está dividido em duas partes principais: o backend e o frontend.

Backend

O backend foi desenvolvido utilizando o framework Spring Boot e implementa uma API RESTful para manipulação das tarefas. O código fonte do backend está localizado no diretório backend.

A estrutura de pacotes do backend > api segue a convenção do Spring Boot:

com.mchalet.todoapp: pacote raiz do projeto
com.mchalet.todoapp.controller: contém os controladores REST para a API
com.mchalet.todoapp.model: define os modelos de dados da aplicação
com.mchalet.todoapp.repository: implementa as operações de acesso aos dados
com.mchalet.todoapp.service: contém as classes de serviço para manipulação das tarefas

Frontend

O frontend foi desenvolvido utilizando React com TypeScript e faz chamadas para a API RESTful fornecida pelo backend. O código fonte do frontend está localizado no diretório frontend > app.

A estrutura do projeto frontend é a seguinte:

src: diretório raiz do código fonte
src/core: contém as interfaces/types/classes para utilização em todo projeto
src/components: contém os componentes reutilizáveis da aplicação
src/hooks: contém os serviços/lógica responsáveis por realizar as chamadas à API
src/App.tsx: contém a página inicial da aplicação

Contribuição

Se desejar contribuir para este projeto, você pode seguir as etapas abaixo:

Faça um fork do repositório
Crie uma nova branch para sua contribuição
Realize as alterações e commit
Faça um push da sua branch para o repositório forkado
Abra um Pull Request para o repositório original

Será um prazer receber suas contribuições!