Skip to content

Esse repositório armazena o backend do ControlCash, app que tem como finalidade facilitar os gastos financeiros do dia a dia.

License

Notifications You must be signed in to change notification settings

Joao-Darwin/controlcash-api

Repository files navigation

star-wars

Control Cash API

GitHub License Badge em Desenvolvimento GitHub closed issues

Índice

Sobre o Projeto

Controll Cash API é a solução backend do meu projeto de gerenciamento financeiro, que possui uma interface tanto em aplicativo quanto em site.

Este projeto foi desenvolvido seguindo todas as boas práticas para criação de uma API RESTful, atingindo um alto nível de maturidade e eficiência.

Principais funcionalidades implementadas:

  • Content Negotiation: Suporte a diferentes formatos de resposta.
  • CORS (Cross-Origin Resource Sharing): Controle de acessos entre domínios.
  • Paginação: Gerenciamento eficiente de endpoints com grandes volumes de dados.
  • Autenticação e Autorização: Garantindo segurança no acesso às informações.
  • Documentação Dinâmica com Swagger: Facilita o consumo e entendimento da API.
  • Testes Unitários e de Integração: Garantia de qualidade e confiabilidade do código.
  • CRUD de todas a entidades: Permite realizar operações com todas as entidades.
  • Docker e docker-compose: Permite executar mais facilmente em qualquer ambiente.

Esta API foi projetada para ser escalável, segura e fácil de integrar, atendendo tanto aplicações web quanto mobile.

Camadas lógicas

Modelo Conceitual

Técnologias Usadas

API

Java

Spring

Apache Maven

Hibernate

Database

Postgres

🚀 Executar o Projeto

Pré-requisitos: Java 17 e Maven

Clonar repositório

git clone https://github.com/Joao-Darwin/controlcash-api ControlCashAPI

Entrar na pasta do projeto

cd ControlCashAPI

Instalar o Maven

sudo apt-get install maven

Instalar depedências do projeto

sudo mvn clean install

Executar o projeto

mvn spring-boot:run

Docker

Clonar repositório

git clone https://github.com/Joao-Darwin/controlcash-api ControlCashAPI

Entrar na pasta do projeto

cd ControlCashAPI

Clone o arquivo com as variáveis de ambiente

cp .env.example .env

Configure as variáveis de ambiente

DATABASE_USER=
DATABASE_PASSWORD=
DATABASE_NAME=
DATABASE_URL=jdbc:postgresql://cca_postgres:5432/database_name?useTimezone=true&serverTimezone=UTC

Executa docker compose

docker compose up

Autor

João Darwin

About

Esse repositório armazena o backend do ControlCash, app que tem como finalidade facilitar os gastos financeiros do dia a dia.

Topics

Resources

License

Stars

Watchers

Forks