AlugaFácil - Sistema de Aluguel de Imóveis

AlugaFácil

Sistema de gerenciamento de aluguel de imóveis desenvolvido com Spring Boot e Next.js
Reportar Bug · Sugerir Feature

Índice

• Sobre o Projeto
  • Tecnologias
• Funcionalidades
• Começando
  • Pré-requisitos
  • Instalação
  • Criando o Primeiro Administrador
• Uso
• Roadmap
• Contribuindo
• Licença
• Contato

Sobre o Projeto

O AlugaFácil é um sistema completo para gerenciamento de aluguéis de imóveis, desenvolvido com tecnologias modernas para oferecer uma experiência eficiente tanto para proprietários quanto para inquilinos.

Tecnologias

Backend

• Java 17
• Spring Boot 3.2.2
• Spring Security com JWT
• Spring Data JPA
• MySQL
• Maven

Frontend

• Next.js 14
• TypeScript
• Tailwind CSS
• Shadcn/ui

Funcionalidades

• Gestão de Imóveis: Cadastro e gerenciamento completo
• Controle de Usuários: Administradores e inquilinos
• Contratos: Geração de contratos de aluguel
• Pagamentos: Controle de pagamentos e histórico
• Dashboard: Visualização de dados e relatórios
• Segurança: Autenticação JWT e controle de acesso

Começando

Pré-requisitos

• Java 17
• Node.js 18+
• MySQL
• Maven

Instalação

1. Clone o repositório:

   git clone https://github.com/HeitorLouzeiroRepositoryIFPI/aluga-facil.git

2. Configure o backend:

   cd backend
   cp .env.example .env   # Configure suas variáveis de ambiente
   mvn install

3. Configure o frontend:

   cd frontend
   npm install

4. Inicie o backend:

   cd backend
   mvn spring-boot:run

5. Inicie o frontend:

   cd frontend
   npm run dev

Criando o Primeiro Administrador

Para criar o primeiro administrador do sistema, faça uma requisição POST para o endpoint:

http://localhost:8080/api/administradores/

Utilize o seguinte JSON no body da requisição:

{
    "nome": "administrador",
    "email": "[email protected]",
    "senha": "12345678",
    "cpf": "54900833606",
    "endereco": "Rua Rio Solimões",
    "telefone": "27987685379",
    "dataNascimento": "2000-06-06"
}

Após criar o primeiro administrador, você poderá fazer login no sistema usando o email e senha cadastrados.

Documentação da API (Swagger)

Após iniciar o backend, você pode acessar a documentação interativa da API através do Swagger UI:

http://localhost:8080/swagger-ui/index.html

No Swagger UI você pode:

• Visualizar todos os endpoints disponíveis
• Testar as requisições diretamente pela interface
• Ver os modelos de dados e parâmetros necessários
• Autenticar-se usando JWT para testar endpoints protegidos

Roadmap

• Autenticação e Autorização
• CRUD de Imóveis
• CRUD de Usuários
• Gestão de Contratos
• Sistema de Pagamentos

Contribuindo

1. Faça um Fork do projeto
2. Crie sua Feature Branch (git checkout -b feature/NovaFuncionalidade)
3. Commit suas mudanças (git commit -m 'Adiciona nova funcionalidade')
4. Push para a Branch (git push origin feature/NovaFuncionalidade)
5. Abra um Pull Request

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contato