+
+
Usuários administrativos regulares podem cadastrar torres, tipos de unidade, unidade de um condomínio, andares, áreas comuns e moradores.
+A fração ideal de cada unidade é gerada automaticamente com base no tamanho de cada uma e a quantidade de unidades em um condomínio.
+Tanto administradores quanto moradores podem ver a página de listagem e detalhes de condomínio. Tendo sua exibição alterada para cada tipo de usuário.
-Moradores podem fazer uma reserva de área comum, bem como cancelar essa reserva.
+Moradores podem fazer uma reserva de área comum a partir de um calendário de reservas, bem como cancelar essa reserva. Gerando ou cancelando cobrança de taxa de uso dessa reserva na aplicação PagueAluguel.
+ +Moradores podem consultar suas faturas e enviar comprovantes de pagamento que serão comunicados através da aplicação PagueAluguel.
+ +Administradores podem registrar entrada de visitantes no condomínio e visualizar uma lista com o histórico de visitas.
+ +Administradores podem criar avisos para serem mostrados em um mural na tela de detalhes de um condomínio.
+ + + - + ## Endpoints da API @@ -124,7 +136,7 @@ Retorna erro 404 caso não exista um condomínio cadastrado com esse id. Exemplo de resposta: ```json { - "name": "Condominio Residencial Paineiras", + "name": "Condomínio Residencial Paineiras", "registration_number": "62.810.952/2718-22", "address": { "public_place": "Travessa João Edimar", @@ -290,7 +302,7 @@ Possíveis respostas ``` Retorna 404 se não existe um proprietário com o CPF informado na aplicação CondoMínios, ou se existe, mas não possui nenhuma unidade como propriedade; Retorna 412 se o CPF não for válido para consulta. -Retorna 200 se o CPF é de um proprietário de alguma unidade e o seguinte JSON +Retorna 200 se o CPF é de um proprietário de alguma unidade e o seguinte JSON. ``` ```json @@ -371,7 +383,7 @@ Exemplo de Resposta: ``` -caso não existam áreas comuns cadastradas para o condomínio informado retorna o `id` do condomínio e um array vazio.
+Caso não existam áreas comuns cadastradas para o condomínio informado retorna o `id` do condomínio e um array vazio.
Retorna erro `404` caso o condomínio informado não esteja cadastrado.
@@ -395,6 +407,9 @@ Exemplo de Resposta:Retorna erro `404` caso a área comum informada não esteja cadastrada para o condomínio informado.
+ + + ## Instalação e Execução @@ -420,6 +435,10 @@ Entre na pasta do projeto: ```sh cd condominions ``` +Instale Bundle: +```sh +bundle install +``` Instale as dependências: ```sh bin/setup @@ -429,14 +448,26 @@ Para popular o banco de dados: rails db:seed ``` - - + + ### Execução de Testes Para rodar os testes, execute: ```sh rake spec ``` +### Testando E-mails + +Caso queria testar emails, você pode fazê-lo instalando a gem [MailCatcher](https://mailcatcher.me/): +```sh +gem install mailcatcher +``` +Para executar o MailCatcher: +```sh +mailcatcher +``` +Agora você pode acessá-lo através da rota http://localhost:1080/ + ### Execução da Aplicação @@ -446,40 +477,39 @@ bin/dev ``` Agora é possível acessar a aplicação a partir da rota http://localhost:3000/ +**Integração com o PagueAluguel**: Essa aplicação foi construída para ser integrada com o [PagueAluguel](https://github.com/TreinaDev/pague-aluguel). Com ambas as aplicações rodando, você poderá utilizá-la com todas as suas funcionalidades! + ## Estrutura do Banco de Dados - + - + -## Banco de Dados Iniciais +## Seeds de Usuários -Dados inseridos no seeds +Esses usuários são gerados nas seeds e você pode utilizá-los para testar a aplicação. >Administradores ->>|Nome Completo|CPF|E-mail|Senha| ->>| :--------: | :--------: |:--------: | :--------: | ->>|Murilo Pereira Rocha|745.808.535-55|adm@teste.com|teste123| - ->Endereços ->>|Rua|Número|Bairro|Cidade|Estado|CEP|ID| ->>| :--------: | :--------: | :--------: | :--------: | :--------: | :--------: | :--------: | ->>|Travessa João Edimar|29|João Eduardo II|Rio Branco|AC|69911-520| 1 | +>>|Nome Completo|E-mail|Senha| +>>| :--------: | :--------: |:--------: | +>>|Ednaldo Pereira|adm@teste.com|teste123| +>>|Adroaldo Silva Santos|adm@teste.com|teste123| ->Condominions ->>|Nome do condomínio|CNPJ|ID do endereço| ->>| :--------: | :--------: | :--------: | ->>|Condominio Residencial Paineiras|62.810.952/2718-22| 1 | +>Residentes +>>|Nome Completo|E-mail|Senha| +>>| :--------: | :--------: |:--------: | +>>|Marina Santos Oliveira|marina@email.com|teste123| +>>|Rafael Souza Lima|rafael@email.com|teste123| - + ## Desenvolvedores @@ -508,4 +538,4 @@ Dados inseridos no seeds [Ruby-url]: https://www.ruby-lang.org/en/news/2023/03/30/ruby-3-2-2-released/ [RubyOnRails.com]: https://img.shields.io/static/v1?label=Ruby%20On%20Rails&message=7.1.3.1&color=red&style=for-the-badge&logo=rubyonrails [RubyOnRails-url]: https://rubyonrails.org/2023/11/10/Rails-7-1-2-has-been-released -[EstruturaDoBancoDeDados-URL]: https://i.imgur.com/emiKwf5.png \ No newline at end of file +[EstruturaDoBancoDeDados-URL]: https://i.imgur.com/emiKwf5.png