From 1e0e02d0f121f0705f53f159cac8fb3cdc6b60dc Mon Sep 17 00:00:00 2001 From: Rulian de Jesus Cruz Date: Mon, 22 Jul 2024 04:29:33 -0300 Subject: [PATCH 1/4] Atualiza README.md. --- README.md | 64 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 9d1372e..3f77c21 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Sumário
  1. - Sobre o projeto + Sobre o Projeto
    • Tecnologias
    • Funcionalidade
      • @@ -39,10 +39,10 @@ @@ -79,9 +79,20 @@

      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.

      + + +

      (voltar ao topo)

      @@ -124,7 +135,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 +301,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 +382,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.

      @@ -420,6 +431,10 @@ Entre na pasta do projeto: ```sh cd condominions ``` +Instale Bundle: +```sh +bundle install +``` Instale as dependências: ```sh bin/setup @@ -446,40 +461,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! +

      (voltar ao topo)

      ## Estrutura do Banco de Dados -![Estrutura do banco de dados](https://i.imgur.com/emiKwf5.png) +![Estrutura do banco de dados](https://github.com/user-attachments/assets/ee40045d-5e22-4404-96c8-be0c573b4fd6)

      (voltar ao topo)

      -## 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|

      (voltar ao topo)

      -
      +
      ## Desenvolvedores From 865c346fc216430f38fb554395afc40584bf7f91 Mon Sep 17 00:00:00 2001 From: Rulian Cruz Date: Mon, 22 Jul 2024 04:47:23 -0300 Subject: [PATCH 2/4] Update README.md --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3f77c21..86a015e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@
      - + [![Contributors][contributors-shield]][contributors-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![Status][status-shield]][status-url] - + +
      @@ -29,7 +30,7 @@
    • Sobre o Projeto @@ -96,7 +97,7 @@

      (voltar ao topo)

      -
      +
      ## Endpoints da API @@ -406,6 +407,7 @@ 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
      @@ -444,14 +446,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 @@ -473,7 +487,7 @@ Agora é possível acessar a aplicação a partir da rota http://localhost:3000/

      (voltar ao topo)

      -
      +
      ## Seeds de Usuários @@ -522,4 +536,4 @@ Esses usuários são gerados nas seeds e você pode utilizá-los para testar a a [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 From 94baa82380c14e68f57d2eb431294e2a180ee654 Mon Sep 17 00:00:00 2001 From: Rulian Cruz Date: Mon, 22 Jul 2024 04:53:43 -0300 Subject: [PATCH 3/4] Atualiza README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 86a015e..0a8fcce 100644 --- a/README.md +++ b/README.md @@ -407,7 +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
      @@ -475,7 +477,7 @@ 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! +**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!

      (voltar ao topo)

      From 2a91815e346f7224fb0a6c8f8e7db4f8faf454e6 Mon Sep 17 00:00:00 2001 From: Rulian Cruz Date: Mon, 22 Jul 2024 05:03:55 -0300 Subject: [PATCH 4/4] Atualiza README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a8fcce..c729292 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![Status][status-shield]][status-url] - +