Merge pull request #59 from ResidenciaTICBrisa/developer

Reestrutração (Sprint 5)
ResidenciaTICBrisa · Apr 7, 2024 · e9ec8a8 · e9ec8a8
2 parents 386767d + 240b976
commit e9ec8a8
Show file tree

Hide file tree

Showing 37 changed files with 782 additions and 484 deletions.
diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md
@@ -1,18 +1,15 @@
----
-name: Issue template
-about: Issue template do projeto
-title: ''
-labels: ''
-assignees: ''
+## Descrição
+Forneça informações claras e concisas para que outros membros da equipe possam entender o contexto e a importância do problema.
 
----
+## Tarefas
+Liste as tarefas específicas que precisam ser concluídas para resolver o problema ou concluir a tarefa, dívida tarefas grandes e complexas em tarefas simples.
+- [ ] Tarefa 1
+- [ ] Tarefa 2
 
-# Etapas para validação:
+## Testes / Avaliação
+Especifique os critérios de teste ou avaliação que serão usados para garantir que a solução seja eficaz. 
+- [ ] Critério 1
+- [ ] Critério 2
 
-- [ ] validação 1
-- [ ] validação 2
-- [ ] validação 3
-
-## Resumo sobre:
-
-Descrição da issue ...
+## Prazos
+Estipule um prazo para qual a entrega da solução/feedback possa ocorrer.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1 @@
 database/
-
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-
+<p align="center">
+  <img src="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/blob/main/docs/assets/images/logo.png" width="190" />
+</p>
 
 # T2G8-Plugin-Wordpress
 

diff --git a/docs/Atas/ata-modelo.md b/docs/Atas/ata-modelo.md
diff --git a/docs/Atas/ata-reuniao1.md b/docs/Atas/ata-reuniao1.md
@@ -1,4 +1,4 @@
-### ATA DE REUNIÃO - SPRINT 0
+### **ATA DE REUNIÃO - SPRINT 1**
 08/03/2024
 
 **Redator:** William Bernardo.

diff --git a/docs/Atas/ata-reuniao2.md b/docs/Atas/ata-reuniao2.md
@@ -1,5 +1,5 @@
 
-### ATA DE REUNIÃO - SPRINT 0
+### **ATA DE REUNIÃO - SPRINT 2**
 15/03/2024
 
 **Redator:** William Bernardo.

diff --git a/docs/Atas/ata-reuniao3.md b/docs/Atas/ata-reuniao3.md
@@ -1,5 +1,5 @@
 
-### ATA DE REUNIÃO - SPRINT X
+### **ATA DE REUNIÃO - SPRINT 3**
 23/03/2024
 
 **Redator:** Gustavo Linhares Lima

diff --git a/docs/Atas/ata-reuniao4.md b/docs/Atas/ata-reuniao4.md
@@ -0,0 +1,31 @@
+### ATA DE REUNIÃO - SPRINT 5
+01/04/2024
+
+**Redator:** William Bernardo
+
+### 1. Membros presentes e ausentes
+**Presentes:** William Bernardo, Max Rohrer, Igor Brandão, Valessio Brito
+
+**Ausentes:** Gustavo Linhares, Marcos Vinicius
+
+### 2. Considerações iniciais da reunião
+
+A reunião iniciou às 19:30
+
+### 3. Pautas da reunião
+
+**1ª Pauta - Feedback do cliente sobre o projeto**
+
+O cliente analisou o atual estado do projeto, reforçando alguns pontos para serem adicionados como: O arquivo zipado do plugin para testes fora do ambiente de desenvolvimento.
+
+**2ª Pauta - Adição de alguns requisitos**
+
+Foram discutidas algumas funcionalidades que podem ser estudadas para adicionar no plugin como: Um painel de administração mais robusto contendo páginas separadas para validação, edição e personalização do formulário e API para mapear empresas a partir do CNPJ.
+
+**3ª Pauta - Ajustes finais para a primeira release**
+
+Estilização do plugin (Referência o wireframe criado anteriormente), mapeamento na tela inicial contendo os locais já cadastrados e realização de testes em dispositivos mobile
+
+### 4. Considerações finais
+
+A reunião se encerrou às 20:20.
diff --git a/docs/arquitetura.md b/docs/arquitetura.md
diff --git a/docs/assets/images/Arquitetura.png b/docs/assets/images/Arquitetura.png
diff --git a/docs/assets/images/Arquitetura_col.drawio.html b/docs/assets/images/Arquitetura_col.drawio.html
diff --git a/docs/assets/images/Roadmap.jpg b/docs/assets/images/Roadmap.jpg
diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
@@ -7,12 +7,12 @@
     align-items: center;
     justify-self: center;
 }
-/* ARTICLE{
-    display: flex;
-    align-items: center;
-    justify-self: center;
-    flex-direction: column;
-} */
+
+.md-logo img {
+    border-radius: 10px; /* Arredondando as bordas */
+}
+
+
 A {
     display: grid;
 

diff --git a/docs/backlog.md b/docs/backlog.md
@@ -1,25 +1,20 @@
-Este documento oferece uma visão abrangente do backlog de nosso produto, destacando as funcionalidades, melhorias e tarefas prioritárias que nossa equipe de desenvolvimento planeja abordar. Ele atua como um guia essencial para alinhar nossos esforços com as demandas dos clientes e os objetivos empresariais, facilitando uma gestão eficiente do ciclo de desenvolvimento e garantindo a entrega constante de valor aos usuários finais.
+# **Backlog**
 
-## Histórico de Versões
+Este documento oferece uma visão abrangente do backlog de nosso produto, destacando as funcionalidades, melhorias e tarefas prioritárias que nossa equipe de desenvolvimento planeja abordar. Ele atua como um guia essencial para alinhar nossos esforços com as demandas dos clientes e os objetivos empresariais, facilitando uma gestão eficiente do ciclo de desenvolvimento e garantindo a entrega constante de valor aos usuários finais.
 
-| Data       | Versão | Descrição            |         Autor             |
-|:----------:|:------:|:--------------------:|:-------------------------:|
-| 10/03/2024 | 0.1.1 | Criação do Documento Backlog com épicos, funcionalidades | @WillxBernardo |
-| 13/03/2024 | 0.1.2 | Criação do plugin protótipo que adiciona o formulário na página | @WillxBernardo |
-| 20/03/2024 | 0.1.3 | Implementação do uso da localização do usário dentro do plugin | @Max-Rohrer20 |
-| 28/03/2024 | 0.2.0 | Inicialização do plugin ser o mapa com acesso para o formulário | @WillxBernardo |
 
 ## Épicos
-| ID | DESCRIÇÃO | ID RELACIONADO (TEMA) |
-|----|-----------|-----------------------|
-| EP01 | Como administrador, quero gerenciar formulários para georreferenciar estabelecimentos/serviços no meu site| TM01 |
+| ID | DESCRIÇÃO |
+|----|-----------|
+| EP01 | Como administrador, quero georreferenciar locais/serviços no meu site|
+| EP02 | Como administrador, desejo administrar os locais/serviços do meu site e gerenciar pedidos de adição no sistema via interface|
 
 ## Funcionalidades (Features)
 | ID | DESCRIÇÃO | ID RELACIONADO (ÉPICOS) |
 |----|-----------|-------------------------|
 | FT00 | Estudos gerais sobre o wordpress| --- |
 | FT01 | Formulário de pedido | EP01 |
-| FT02 | Interface de gerenciamento de formulários | EP01 |
+| FT02 | Interface de gerenciamento de formulários | EP02 |
 | FT03 | Georreferenciamento dos estabelecimentos/serviços| EP01 |
 
 
@@ -43,6 +38,59 @@ Este documento oferece uma visão abrangente do backlog de nosso produto, destac
 |    US08    | Administrador | Validar os formulários enviados | Consiga aceitar/rejeitar os formulários | FT02 |
 |    US09    | Administrador | Eu acesse as respostas do formulário diretamente no painel do WordPress | Não seja necessário acessar toda vez o meu banco de dados | FT02 |
 |    US10    | Administrador | Enviar um e-mail ao usuário quando sua solicitação for respondida | O usuário tenha ciência do resultado do processamento | FT02 |
-|    US11    | Administrador |  editar as informações de uma zona segura existente, como o nome, endereço e descrição |  para manter as informações atualizadas | FT02 |
-|    US12    | Administrador | Poder adicionar um mapa na página | Seja exibido no mapa quais estabelecimentos já estão cadastrados | FT03 |
-|    US13    | Usuário | poder visualizar detalhes de uma zona segura, como o nome, endereço, descrição e classificação | decidir se é um local adequado para mim | FT03 |
+|    US11    | Administrador | Editar as informações de uma zona segura existente, como o nome, endereço e descrição |  para manter as informações atualizadas | FT02 |
+|    US12    | Administrador | Personalizar os campos do formulário |  Eu receba as informações pertinentes do local que eu considere relevantes | FT02 |
+|    US13    | Administrador | Poder adicionar um mapa na página | Seja exibido no mapa quais estabelecimentos já estão cadastrados | FT03 |
+|    US14    | Usuário | visualizar detalhes de uma zona segura, como: nome, endereço, descrição e classificação | decidir se é um local adequado para mim | FT03 |
+
+## Requisitos
+
+### Requisitos Funcionais
+
+- **Integração com Mapas:** O plugin deve se integrar com serviços de mapas, com o OpenStreetMap, para exibir visualmente as Safe Zones e permitir a navegação pelos mapas.
+
+- **Formulário de Proposição de Safe Zone:** O plugin deve fornecer um formulário na interface para que os usuários possam propor novas Safe Zones, inserindo informações como nome, endereço e descrição do local.
+
+- **Avaliação:** Os usuários devem poder avaliar as Safe Zones existentes através da interface do plugin. As avaliações devem ser exibidos de forma clara e organizada na interface para que outros usuários possam ver.
+
+- **Visualização de Sugestões de Locais:** O sistema deve fornecer uma interface para os administradores visualizarem todas as sugestões de locais enviadas pelos usuários para verificação.
+
+- **Aprovação/Rejeição de Sugestões de Locais:** Os administradores devem ter a capacidade de aprovar ou rejeitar sugestões de locais enviadas pelos usuários, atribuindo o status de "Aprovado" ou "Rejeitado" a cada uma delas.
+
+- **Busca por Zonas Seguras:** O sistema deve permitir aos usuários realizar buscas por zonas seguras próximas à sua localização atual para encontrar locais seguros na região desejada.
+
+- **Visualização de Detalhes de Zonas Seguras:** Os usuários devem ser capazes de visualizar detalhes de uma zona segura, incluindo nome, endereço, descrição e classificação, para avaliar se é um local adequado para eles.
+
+- **Acompanhamento do Status da Região:** O sistema deve enviar um e-mail de confirmação para os usuários após o envio do formulário, para que possam acompanhar o status da região que sugeriram.
+
+
+### Requisitos Não Funcionais
+
+- **Usabilidade:** O plugin deve ser fácil de usar e intuitivo para o usuário final, com uma interface amigável e instruções claras.
+
+- **Desempenho:** O sistema deve ser capaz de lidar com um grande volume de dados e usuários simultâneos sem comprometer a velocidade ou a qualidade do serviço.
+
+- **Segurança:** O plugin deve garantir a segurança dos dados dos usuários e a integridade das informações, utilizando criptografia e práticas de segurança recomendadas.
+
+- **Compatibilidade:** O plugin deve ser compatível com diferentes navegadores web, sistemas operacionais e  com dispositivos móveis, garantindo uma experiência consistente para todos os usuários.
+
+- **Manutenibilidade:** O código do plugin deve ser bem estruturado e documentado, facilitando futuras atualizações e manutenções.
+
+- **Escalabilidade:** O sistema deve ser capaz de se adaptar e escalar conforme necessário, para lidar com um aumento no número de usuários e locais cadastrados.
+
+- **Disponibilidade:** O plugin deve estar disponível e acessível para os usuários a maior parte do tempo, com um tempo de inatividade mínimo planejado para manutenção.
+
+- **Privacidade:** O plugin deve respeitar a privacidade dos usuários, garantindo que suas informações pessoais sejam protegidas e utilizadas apenas para os fins específicos do plugin.
+
+- **Acessibilidade:** O plugin deve ser acessível para usuários com deficiências, seguindo as diretrizes de acessibilidade web e garantindo uma experiência inclusiva para todos.
+
+
+## Histórico de Versões
+
+| Data       | Versão | Descrição            |         Autor             |
+|:----------:|:------:|:--------------------:|:-------------------------:|
+| 10/03/2024 | 0.1.1 | Criação do Documento Backlog com épicos, funcionalidades | @WillxBernardo |
+| 13/03/2024 | 0.1.2 | Criação do plugin protótipo que adiciona o formulário na página | @WillxBernardo |
+| 20/03/2024 | 0.1.3 | Implementação do uso da localização do usário dentro do plugin | @Max-Rohrer20 |
+| 28/03/2024 | 0.2.0 | Inicialização do plugin ser o mapa com acesso para o formulário | @WillxBernardo |
+| 05/04/2024 | 0.3.0 | Reestruturação do código base | @WillxBernardo |
diff --git a/docs/index.md b/docs/index.md
@@ -1,12 +1,23 @@
+# **T2G8-Plugin-Wordpress**
 
+Bem-vindo ao repositório oficial do LGBTQ+ Connect! Nosso projeto tem como principal objetivo conectar empreendimentos e serviços LGBTQ+ friendly com toda a comunidade. Através dessa plataforma, buscamos promover a inclusão, visibilidade e apoio mútuo dentro da comunidade, fortalecendo laços e ampliando oportunidades para todos. Junte-se a nós nessa jornada rumo a um mundo mais igualitário e acolhedor para todas as identidades de gênero e orientações sexuais!
 
-# T2G8-Plugin-Wordpress
+## Sobre o Projeto
 
-Bem-vindo ao repositório oficial do LGBTQIAPN+ Connect! Nosso projeto tem como principal objetivo conectar empreendimentos e serviços LGBTQIAPN+ friendly com toda a comunidade LGBTQIAPN+. Através dessa plataforma, buscamos promover a inclusão, visibilidade e apoio mútuo dentro da comunidade, fortalecendo laços e ampliando oportunidades para todos. Junte-se a nós nessa jornada rumo a um mundo mais igualitário e acolhedor para todas as identidades de gênero e orientações sexuais!
+O projeto consiste no desenvolvimento de um plugin de rastreamento de áreas seguras (Safe Zones) para a comunidade LGBTQ+ no Brasil. O objetivo principal é fornecer uma plataforma segura e inclusiva que permita aos usuários identificar e compartilhar locais seguros em suas comunidades, como bares, restaurantes, centros comunitários e outros estabelecimentos que sejam acolhedores e respeitosos com a comunidade LGBT. O plugin terá uma interface intuitiva e responsiva, permitindo aos usuários navegar facilmente pelo mapa de Safe Zones, adicionar novos locais e avaliar a segurança e inclusão de estabelecimentos existentes. A integração com uma plataforma de rastreamento de áreas seguras permitirá a comunicação em tempo real e o compartilhamento de informações entre os usuários. O projeto será desenvolvido em quatro releases principais, com atividades como definição de objetivos, pesquisa, desenvolvimento do front-end e back-end, integração com a plataforma de rastreamento, testes e correções, lançamento e promoção do plugin, e monitoramento e manutenção inicial após o lançamento. O objetivo final é criar uma ferramenta poderosa e positiva que contribua para a segurança e bem-estar da comunidade LGBTQ+ no Brasil.
 
-## Sobre o Projeto
 
-O projeto consiste no desenvolvimento de um plugin de rastreamento de áreas seguras (Safe Zones) para a comunidade LGBT no Brasil. O objetivo principal é fornecer uma plataforma segura e inclusiva que permita aos usuários identificar e compartilhar locais seguros em suas comunidades, como bares, restaurantes, centros comunitários e outros estabelecimentos que sejam acolhedores e respeitosos com a comunidade LGBT. O plugin terá uma interface intuitiva e responsiva, permitindo aos usuários navegar facilmente pelo mapa de Safe Zones, adicionar novos locais e avaliar a segurança e inclusão de estabelecimentos existentes. A integração com uma plataforma de rastreamento de áreas seguras permitirá a comunicação em tempo real e o compartilhamento de informações entre os usuários. O projeto será desenvolvido em quatro releases principais, com atividades como definição de objetivos, pesquisa, desenvolvimento do front-end e back-end, integração com a plataforma de rastreamento, testes e correções, lançamento e promoção do plugin, e monitoramento e manutenção inicial após o lançamento. O objetivo final é criar uma ferramenta poderosa e positiva que contribua para a segurança e bem-estar da comunidade LGBT no Brasil.
+## Tencnologias utilziadas
+
+- **Wordpress:** O LGBTQ+ Connect é um plugin criado com o objetivo de atender donos de site ou empresas que utilizam a ferramenta do wordpress.
+
+- **MySQL:** O wordpress utiliza por padrão o MySQL para gerênciamento do banco de dados.
+
+- **JavaScript:** No frontend o javascript se tornou uma ótima opção para lidar com os eventos envolvendo o formulário, além de ser uma técnologia muito utilizada em plugins para wordpress.
+
+- **Leaflet:** Para o georreferenciamento dos locais utilizamos o leaflet, uma biblioteca JavaScript que atende de forma completa os requisitos do nosso projeto.
+
+- **Docker:** Utilizamos o docker para nivelação do ambiente de desenvolvimento entre os membros do time.
 
 ## Desenvolvedores
 

diff --git a/docs/preparandoambiente.md b/docs/preparandoambiente.md
@@ -1,4 +1,4 @@
-# Criando ambiente para desenvolvimento
+# **Criando ambiente para desenvolvimento**
 
 Os comandos listados a seguir são para dispositivos linux.
 
@@ -31,21 +31,25 @@ docker compose ps
 
 - Em um navegador acesse as respectivas portas:
 
-    <a href="http://localhost:8082" style="color: green;" target="_blank"> -> * localhost:8082</a>
-    <a href="http://localhost:8083" style="color: green;" target="_blank"> -> * localhost:8083</a>
+    <p>
+    <strong>Wordpress:</strong>
+    <a href="http://localhost:8082" style="color: green; display: inline;" target="_blank">localhost:8082</a><br>
+    <strong>PhpMyAdmin:</strong>
+    <a href="http://localhost:8083" style="color: green; display: inline;" target="_blank">localhost:8083</a>
+    </p>
 
     -> No wordpress faça a configuração incial para acessar o wordpress
 
-    -> No PhpMyAdmin faça login com <span style="color: green;">**Usuário: Admin** e **Senha: Admin**</span>
+    -> No PhpMyAdmin faça login com <span style="color: blue;">**Usuário: Admin** e **Senha: Admin**</span>
 
 - Realize as configurações do wordpress para criar seu site
 
 - No caso de após a configuração do wordpress não ser redirecionado para a página de admin acesse:
 
-    <a href="http://localhost:8082/wp-admin" style="color: green;" target="_blank"> -> localhost:8082/wp-admin</a>
+    <a href="http://localhost:8082/wp-admin" style="color: green;" target="_blank">localhost:8082/wp-admin</a>
 
 - Em teoria, o plugin LGBTQ+ Connect já é adicionado ao seu wordpress automaticamente, caso não esteja listado na aba plugins realize os seguintes passos, em caso contrário pode pular essa etapa.
 
     * Na tela de plugins do wordpress clique em adicionar plugin, navegue para o repositório do projeto e selecione o arquivo zipado do plugin
 
-- Em qualquer página do seu site escreva o seguinte shortcode: **[mostrar_mapa]**
+- Em qualquer página do seu site escreva o seguinte shortcode: **[lgbtq_connect]**