Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Atualiza informações do README.md #142

Merged
merged 5 commits into from
Jul 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 63 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
<a id="readme-top"></a>

<div align="center">

[![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]

<img src="http://img.shields.io/static/v1?label=Test%20Coverage&message=98.61%&color=green&style=for-the-badge"/>

</div>

<!-- PROJECT LOGO -->
Expand All @@ -27,9 +28,9 @@
<summary>Sumário</summary>
<ol>
<li>
<a href="#sobre-o-projeto">Sobre o projeto</a>
<a href="#sobre-o-projeto">Sobre o Projeto</a>
<ul>
<li><a href="#Tecnologias">Tecnologias</a></li>
<li><a href="#tecnologias">Tecnologias</a></li>
<li><a href="#funcionalidade">Funcionalidade</a></li>
<li><a href="#endpoints-da-api">Endpoints da API</a></li>
</ul>
Expand All @@ -39,10 +40,10 @@
<ul>
<li><a href="#pre-requisitos">Pré-Requisitos</a></li>
<li><a href="#instalacao">Instalação</a></li>
<li><a href="#execucao-de-testes">Execução de testes</a></li>
<li><a href="#execucao-da-aplicacao">Execução da aplicação</a></li>
<li><a href="#estrutura-banco-de-dados">Estrutura banco de dados</a></li>
<li><a href="#banco-de-dados">Banco de dados</a></li>
<li><a href="#execucao-de-testes">Execução de Testes</a></li>
<li><a href="#execucao-da-aplicacao">Execução da Aplicação</a></li>
<li><a href="#estrutura-banco-de-dados">Estrutura do Banco de Dados</a></li>
<li><a href="#seeds-de-usuarios">Seeds de Usuários</a></li>
<li><a href="#desenvolvedores">Desenvolvedores</a></li>
</ul>
</li>
Expand Down Expand Up @@ -79,13 +80,24 @@

<p align="justify">Usuários administrativos regulares podem cadastrar torres, tipos de unidade, unidade de um condomínio, andares, áreas comuns e moradores.</p>

<p align="justify">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.</p>

<p align="justify">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.</p>

<p align="justify">Moradores podem fazer uma reserva de área comum, bem como cancelar essa reserva.</p>
<p align="justify">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.</p>

<p align="justify">Moradores podem consultar suas faturas e enviar comprovantes de pagamento que serão comunicados através da aplicação PagueAluguel.</p>

<p align="justify">Administradores podem registrar entrada de visitantes no condomínio e visualizar uma lista com o histórico de visitas.</p>

<p align="justify">Administradores podem criar avisos para serem mostrados em um mural na tela de detalhes de um condomínio.</p>




<p align="right">(<a href="#readme-top">voltar ao topo</a>)</p>

<div id='instalacao-e-execucao'/>
<div id='endpoints-da-api'/>

## Endpoints da API

Expand Down Expand Up @@ -124,7 +136,7 @@ Retorna erro 404 caso não exista um condomínio cadastrado com esse id.</p>
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",
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -371,7 +383,7 @@ Exemplo de Resposta:

```

<p align="justify">caso não existam áreas comuns cadastradas para o condomínio informado retorna o `id` do condomínio e um array vazio.</p>
<p align="justify">Caso não existam áreas comuns cadastradas para o condomínio informado retorna o `id` do condomínio e um array vazio.</p>

<p align="justify">Retorna erro `404` caso o condomínio informado não esteja cadastrado.</p>

Expand All @@ -395,6 +407,9 @@ Exemplo de Resposta:
<p align="justify">Retorna erro `404` caso a área comum informada não esteja cadastrada para o condomínio informado.</p>

<!-- GETTING STARTED -->

<div id='instalacao-e-execucao'/>

## Instalação e Execução

<div id='pre-requisitos'/>
Expand All @@ -420,6 +435,10 @@ Entre na pasta do projeto:
```sh
cd condominions
```
Instale Bundle:
```sh
bundle install
```
Instale as dependências:
```sh
bin/setup
Expand All @@ -429,14 +448,26 @@ Para popular o banco de dados:
rails db:seed
```

<div id='execucao-de-testes'/>

<div id='execucao-de-testes'/>
### 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/

<div id='execucao-da-aplicacao'/>

### Execução da Aplicação
Expand All @@ -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!

<p align="right">(<a href="#readme-top">voltar ao topo</a>)</p>

<div id='estrutura-banco-de-dados'/>

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

<p align="right">(<a href="#readme-top">voltar ao topo</a>)</p>

<div id='banco-de-dados'/>
<div id='seeds-de-usuarios'/>

## 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|[email protected]|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|[email protected]|teste123|
>>|Adroaldo Silva Santos|[email protected]|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|[email protected]|teste123|
>>|Rafael Souza Lima|[email protected]|teste123|

<p align="right">(<a href="#readme-top">voltar ao topo</a>)</p>

<div id='desenvolvedores'/>
<div id='desenvolvedores'/>

## Desenvolvedores

Expand Down Expand Up @@ -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
[EstruturaDoBancoDeDados-URL]: https://i.imgur.com/emiKwf5.png
Loading