diff --git a/docs/README.md b/docs/README.md deleted file mode 100755 index f8aecebc..00000000 --- a/docs/README.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# T2G8-Plugin-Wordpress - -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! - -## 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. - -## Tecnologias utilizadas - -- **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 - -| ![Maximiliano Rohrer Martins Junior](https://avatars.githubusercontent.com/u/160171332?v=4) | ![William Bernardo da Silva](https://avatars.githubusercontent.com/u/124713089?v=4) | ![Igor Brandão Costa](https://avatars.githubusercontent.com/u/111445872?v=4) | ![Gustavo Linhares Lima](https://avatars.githubusercontent.com/u/143884487?v=4) | ![Marcos Vinicius Gündel da Silva](https://avatars.githubusercontent.com/u/85762681?v=4) | -|:---:|:---:|:---:|:---:|:---:| -| [Maximiliano Rohrer Martins Junior](https://github.com/Max-Rohrer20) | [William Bernardo da Silva](https://github.com/WillxBernardo) | [Igor Brandão Costa](https://github.com/Punkrig) | [Gustavo Linhares Lima](https://github.com/guslnhm) | [Marcos Vinicius Gündel da Silva](https://github.com/MarcosViniciusG) | diff --git a/docs/_coverpage.md b/docs/_coverpage.md deleted file mode 100644 index cced7679..00000000 --- a/docs/_coverpage.md +++ /dev/null @@ -1,23 +0,0 @@ - - - - -LGBTQ+ Connect - -> Um plugin para WordPress projetado para simplificar o mapeamento georreferenciado de empreendimentos e serviços voltados para a comunidade LGBTQIAP+. - -- BRISA -- FGA/UnB - -[Documentação](README.md) -[GitHub](https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress) - - -![](_media/bg1.png) \ No newline at end of file diff --git a/docs/_media/Marker_Academia.png b/docs/_media/Marker_Academia.png deleted file mode 100644 index 8009989a..00000000 Binary files a/docs/_media/Marker_Academia.png and /dev/null differ diff --git a/docs/_media/Marker_Apoio_Juridico.png b/docs/_media/Marker_Apoio_Juridico.png deleted file mode 100644 index b73db745..00000000 Binary files a/docs/_media/Marker_Apoio_Juridico.png and /dev/null differ diff --git a/docs/_media/Marker_Bares_Restaurante.png b/docs/_media/Marker_Bares_Restaurante.png deleted file mode 100644 index 25a986b0..00000000 Binary files a/docs/_media/Marker_Bares_Restaurante.png and /dev/null differ diff --git a/docs/_media/Marker_Beleza.png b/docs/_media/Marker_Beleza.png deleted file mode 100644 index 65c8380f..00000000 Binary files a/docs/_media/Marker_Beleza.png and /dev/null differ diff --git a/docs/_media/Marker_Ensino.png b/docs/_media/Marker_Ensino.png deleted file mode 100644 index 703ecdef..00000000 Binary files a/docs/_media/Marker_Ensino.png and /dev/null differ diff --git a/docs/_media/Marker_Entretenimento.png b/docs/_media/Marker_Entretenimento.png deleted file mode 100644 index d36abeb4..00000000 Binary files a/docs/_media/Marker_Entretenimento.png and /dev/null differ diff --git a/docs/_media/Marker_Hospedagem.png b/docs/_media/Marker_Hospedagem.png deleted file mode 100644 index 7e932e35..00000000 Binary files a/docs/_media/Marker_Hospedagem.png and /dev/null differ diff --git a/docs/_media/custom_marker.png b/docs/_media/custom_marker.png deleted file mode 100644 index 902fc3bc..00000000 Binary files a/docs/_media/custom_marker.png and /dev/null differ diff --git a/docs/_media/tutorial1.1.png b/docs/_media/tutorial1.1.png deleted file mode 100644 index 1898c557..00000000 Binary files a/docs/_media/tutorial1.1.png and /dev/null differ diff --git a/docs/_media/tutorial1.2.png b/docs/_media/tutorial1.2.png deleted file mode 100644 index 7f6e0d91..00000000 Binary files a/docs/_media/tutorial1.2.png and /dev/null differ diff --git a/docs/_media/tutorial1.3.png b/docs/_media/tutorial1.3.png deleted file mode 100644 index 089c6d03..00000000 Binary files a/docs/_media/tutorial1.3.png and /dev/null differ diff --git a/docs/_media/tutorial2.1.png b/docs/_media/tutorial2.1.png deleted file mode 100644 index 3723cff6..00000000 Binary files a/docs/_media/tutorial2.1.png and /dev/null differ diff --git a/docs/_media/tutorial2.2.png b/docs/_media/tutorial2.2.png deleted file mode 100644 index 5fe6138a..00000000 Binary files a/docs/_media/tutorial2.2.png and /dev/null differ diff --git a/docs/_media/tutorial2.3.png b/docs/_media/tutorial2.3.png deleted file mode 100644 index 539ad82c..00000000 Binary files a/docs/_media/tutorial2.3.png and /dev/null differ diff --git a/docs/_media/tutorial2.4.png b/docs/_media/tutorial2.4.png deleted file mode 100644 index 41743f64..00000000 Binary files a/docs/_media/tutorial2.4.png and /dev/null differ diff --git a/docs/_media/tutorial2.5.png b/docs/_media/tutorial2.5.png deleted file mode 100644 index c7d3bac0..00000000 Binary files a/docs/_media/tutorial2.5.png and /dev/null differ diff --git a/docs/_media/tutorial3.1.png b/docs/_media/tutorial3.1.png deleted file mode 100644 index 18c4959a..00000000 Binary files a/docs/_media/tutorial3.1.png and /dev/null differ diff --git a/docs/_media/tutorial3.2.png b/docs/_media/tutorial3.2.png deleted file mode 100644 index cddfbb36..00000000 Binary files a/docs/_media/tutorial3.2.png and /dev/null differ diff --git a/docs/_media/tutorial3.3.png b/docs/_media/tutorial3.3.png deleted file mode 100644 index 3978faad..00000000 Binary files a/docs/_media/tutorial3.3.png and /dev/null differ diff --git a/docs/_media/tutorial3.4.png b/docs/_media/tutorial3.4.png deleted file mode 100644 index 97927ffa..00000000 Binary files a/docs/_media/tutorial3.4.png and /dev/null differ diff --git a/docs/_media/tutorial3.5.png b/docs/_media/tutorial3.5.png deleted file mode 100644 index ff5899f7..00000000 Binary files a/docs/_media/tutorial3.5.png and /dev/null differ diff --git a/docs/_navbar.md b/docs/_navbar.md deleted file mode 100644 index 986b6ff0..00000000 --- a/docs/_navbar.md +++ /dev/null @@ -1,21 +0,0 @@ - -* [Home](README.md) -* [Tutorial](tutorial.md) -* [Preparando ambiente](preparandoambiente.md) -* [Wireframes](wireframe.md) -* [Backlog](backlog.md) -* [Arquitetura](arquitetura.md) -* [Storymap](storymap.md) -* [Roadmap](roadmap.md) -* Atas - * [Ata reunião 1](/atas/ata-reuniao1.md) - * [Ata reunião 2](/atas/ata-reuniao2.md) - * [Ata reunião 3](/atas/ata-reuniao3.md) - * [Ata reunião 4](/atas/ata-reuniao4.md) - * [Ata reunião 5](/atas/ata-reuniao5.md) - * [Ata reunião 6](/atas/ata-reuniao6.md) -* Releases - * [Release 1](/releases/release1.md) - * [Release 2](/releases/release2.md) - * [Release 3](/releases/release3.md) -* [Tutoriais](tutorialmarcadores.md) diff --git a/docs/arquitetura.md b/docs/arquitetura.md deleted file mode 100755 index fbbf39fd..00000000 --- a/docs/arquitetura.md +++ /dev/null @@ -1,29 +0,0 @@ -# **Arquitetura** - - - - - -Arquitetura_col - - -
- - - - -## Restrições -- O controller e o model devem se comunicar de forma eficiente e segura. -- O uso de PHP e SQL para backend está em conformidade com os padrões tecnológicos utilizados pelo wordpress. - -## Argumento -A divisão da arquitetura permite uma melhor organização do código, facilitando a manutenção e a evolução do plugin. - -## Requisitos Relacionados -- Requisitos de desempenho para garantir que a comunicação entre os elementos seja rápida e eficiente. -- Requisitos de segurança para proteger os dados transmitidos entre o frontend e backend. - -## Princípios Relacionados -- Princípios de separação de responsabilidades para garantir que cada camada da arquitetura tenha uma função clara e específica. - - diff --git a/docs/assets/images/Arquitetura_col.drawio.html b/docs/assets/images/Arquitetura_col.drawio.html deleted file mode 100644 index b0568d3a..00000000 --- a/docs/assets/images/Arquitetura_col.drawio.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - -Arquitetura_col - - -
- - - \ No newline at end of file diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css deleted file mode 100755 index 4f4d5a3c..00000000 --- a/docs/assets/stylesheets/extra.css +++ /dev/null @@ -1,57 +0,0 @@ -@import url('https://fonts.googleapis.com/css2?family=Montserrat&family=Ubuntu&display=swap'); - -#t2g8-plugin-wordpress, #sobre-o-projeto, #desenvolvedores{ - color: grey; - font-weight: 500; - display: flex; - align-items: center; - justify-self: center; -} - -.md-logo img { - border-radius: 10px; /* Arredondando as bordas */ -} - - -A { - display: grid; - - -} -.md-tabs{ - display: flex; -} - - -/* Oculta a navbar em dispositivos móveis */ -@media (max-width: 767px) { - .md-tabs { - display: none; - } - -} - -/* .md-header{ - background-color: coral; -} */ - -/* .md-header__title{ - font-size: 28px; -} */ - -/* .md-header__ellipsis{ - background-color: lime; -} - -.md-header__topic{ - background-color: blueviolet; -} - -.md-header__title{ - background-color: chocolate; -} */ - -/* .md-content__inner{ - background-color: #F5F5F5; - border: 1px solid #D0D0D0; -} */ \ No newline at end of file diff --git a/docs/assets_Antigo/images/Arquitetura_col.drawio.html b/docs/assets_Antigo/images/Arquitetura_col.drawio.html deleted file mode 100644 index b0568d3a..00000000 --- a/docs/assets_Antigo/images/Arquitetura_col.drawio.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - -Arquitetura_col - - -
- - - \ No newline at end of file diff --git a/docs/assets_Antigo/images/logo.png b/docs/assets_Antigo/images/logo.png deleted file mode 100644 index a08ae3e6..00000000 Binary files a/docs/assets_Antigo/images/logo.png and /dev/null differ diff --git a/docs/assets_Antigo/stylesheets/extra.css b/docs/assets_Antigo/stylesheets/extra.css deleted file mode 100755 index 4f4d5a3c..00000000 --- a/docs/assets_Antigo/stylesheets/extra.css +++ /dev/null @@ -1,57 +0,0 @@ -@import url('https://fonts.googleapis.com/css2?family=Montserrat&family=Ubuntu&display=swap'); - -#t2g8-plugin-wordpress, #sobre-o-projeto, #desenvolvedores{ - color: grey; - font-weight: 500; - display: flex; - align-items: center; - justify-self: center; -} - -.md-logo img { - border-radius: 10px; /* Arredondando as bordas */ -} - - -A { - display: grid; - - -} -.md-tabs{ - display: flex; -} - - -/* Oculta a navbar em dispositivos móveis */ -@media (max-width: 767px) { - .md-tabs { - display: none; - } - -} - -/* .md-header{ - background-color: coral; -} */ - -/* .md-header__title{ - font-size: 28px; -} */ - -/* .md-header__ellipsis{ - background-color: lime; -} - -.md-header__topic{ - background-color: blueviolet; -} - -.md-header__title{ - background-color: chocolate; -} */ - -/* .md-content__inner{ - background-color: #F5F5F5; - border: 1px solid #D0D0D0; -} */ \ No newline at end of file diff --git a/docs/atas/ata-reuniao1.md b/docs/atas/ata-reuniao1.md deleted file mode 100755 index 6692d907..00000000 --- a/docs/atas/ata-reuniao1.md +++ /dev/null @@ -1,50 +0,0 @@ -### **ATA DE REUNIÃO - SPRINT 1** -08/03/2024 - -**Redator:** William Bernardo. - -#### 1.Membros presentes e ausentes - -**Presentes:** William Bernardo, Max Rohrer, Igor Brandão, Valessio Brito - -**Ausentes:** - -#### 2.Considerações iniciais da reunião - -A reunião iniciou às 18:12 horas via Discord. - -#### 3.Pautas da reunião - -**1ª Pauta - Decisão do nome do plugin** - -O cliente entregou a escolha para a própria equipe. Porém, por questões de mecanismos de busca -deve conter o nome LGBTQ+ e o nome deve ser em inglês. - - -**2ª Pauta - Quais elementos que vão relacionar a comunidade LGBTQIAPN+ com o plugin** - -Elementos visuais na plotagem do mapa devem fazer essa relação. - -**3ª Pauta - Definição da licença utilizada** - -O cliente entregou a escolha para a equipe de desenvolvimento, sendo necessária a avaliação -entre opções como: GPL, MIT, BSD, ... - -**4ª Pauta - Definição se o plugin terá compatibilidade com a linguagem de blocos Gutenberg** - -Por se tratar de um produto MVP a princípio o plugin não irá ser compatível. - -**5ª Pauta - Definição se haverá o site da documentação do plugin ou não** - -Ficou definido que será o próprio site de documentação do projeto (gitpages). - -**6ª Pauta - Descrição detalhada de como o formulário deve funcionar** - -Simples e estático para esse primeiro momento do projeto contendo campos mínimos como: -titulo, descrição, email e a parte de seleção no mapa. Sem ferramentas de personalização por -parte do plugin. E confirmação via email. - - -#### 4.Considerações finais - -A reunião se encerrou às 19:23 horas. \ No newline at end of file diff --git a/docs/atas/ata-reuniao2.md b/docs/atas/ata-reuniao2.md deleted file mode 100755 index ecd02015..00000000 --- a/docs/atas/ata-reuniao2.md +++ /dev/null @@ -1,39 +0,0 @@ - -### **ATA DE REUNIÃO - SPRINT 2** -15/03/2024 - -**Redator:** William Bernardo. - -#### 1.Membros presentes e ausentes - -**Presentes:** William Bernardo, Max Rohrer, Igor Brandão, Valessio Brito - -**Ausentes:** - -#### 2.Considerações iniciais da reunião - -A reunião iniciou às 08:08 horas via Discord. - -#### 3.Pautas da reunião - -**1ª Pauta - Análise do plugin protótipo** - -Foi verificado o plugin protótipo, verificou-se que está bem encaminhado, porém com a necessidade de algumas alterações -como: Criação de novos campos como título, ateração da ordem dos campos (seleção no mapa ser o último), além de alterar o nome de alguns campos (Nome). - -**2ª Pauta - Análise da documentação do projeto** - -Há falha/falta na documentação das primeiras semanas do projeto, faltando documentos importantes como: wireframe, roadmap, adicionar mais issues no backlog. A falha nesses pontos traz atrasos para acompanhamentos no projeto. - -**3ª Pauta - Definição de etapas iniciais** - -- Analise de similares -- Especificação mínima do projeto (Fluxo de interação/funcionalidades) -- Wireframe (prototipagem de baixo nível) -- Criar Plano de Trabalho (issues no Kanban? agrupar por releases/lançamento? prazos estimado) -- Documentação básica da metodologia de desenvolvimento do código/plugin/registro das reuniões/ata/etc... - - -#### 4.Considerações finais - -A reunião se encerrou às 08:50 horas. \ No newline at end of file diff --git a/docs/atas/ata-reuniao3.md b/docs/atas/ata-reuniao3.md deleted file mode 100644 index f403b1ca..00000000 --- a/docs/atas/ata-reuniao3.md +++ /dev/null @@ -1,29 +0,0 @@ - -### **ATA DE REUNIÃO - SPRINT 3** -23/03/2024 - -**Redator:** Gustavo Linhares Lima - -### 1. Membros presentes e ausentes -**Presentes:** William Bernardo, Max Rohrer, Igor Brandão, Gustavo Linhares, Valessio Brito - -**Ausentes:** - -### 2. Considerações iniciais da reunião - -A reunião iniciou às 16:08 - -### 3. Pautas da reunião - -**1ª Pauta - Acesso do cliente ao GitHub** - -O cliente propôs que o mesmo tivesse acesso ao GitHub para que pudesse comentar as issues, permitindo, assim, que ele esteja atualizado, em tempo real, das evoluções no projeto. Foi concedido o acesso do cliente ao repositório. - -**2ª Pauta - Revisão das entregas: wireframe, roadmap e documentação** - -O cliente recebeu as entregas trabalhadas ao longo da sprint, e propôs revisá-las e entregar um feedback por escrito. - - -### 4. Considerações finais - -A reunião se encerrou às 16:34. \ No newline at end of file diff --git a/docs/atas/ata-reuniao4.md b/docs/atas/ata-reuniao4.md deleted file mode 100644 index bffe0d8f..00000000 --- a/docs/atas/ata-reuniao4.md +++ /dev/null @@ -1,31 +0,0 @@ -### 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. \ No newline at end of file diff --git a/docs/atas/ata-reuniao5.md b/docs/atas/ata-reuniao5.md deleted file mode 100644 index d7ac63dd..00000000 --- a/docs/atas/ata-reuniao5.md +++ /dev/null @@ -1,36 +0,0 @@ -### ATA DE REUNIÃO - SPRINT 9 - -29/04/2024 - -**Redator:** William Bernardo - -### 1. Membros presentes e ausentes -**Presentes:** William Bernardo, Max Rohrer, Valessio Brito - -**Ausentes:** Gustavo Linhares, Marcos Vinicius, Igor Brandão - -### 2. Considerações iniciais da reunião - -A reunião iniciou às 19:40 - -### 3. Pautas da reunião - -**1ª Pauta - Feedback do cliente sobre o projeto** - -O cliente analisou o atual estado do projeto, foi comentado sobre o produto estar bem encaminhado e contendo as funcionalidades básicas necessárias para o comprimento do plugin de forma primária. - -**2ª Pauta - Configuração do ambiente de produção (VM)** - -Durante algumas sprints a equipe não conseguiu configurar o ambiente de produção corretamente, durante a reunião o cliente auxiliou na configuração que foi concluida com sucesso, podendo ser configurado o wordpress e a criação de um site teste para o ambiente de produção. - -**3ª Pauta - Utilização da VM com o plugin** - -Após a configuração já foi iniciado a utilização do plugin em seu estado atual no ambiente de produção, notando-se alguns erros principalmente relacionados a estilização do plugin influenciando o uso no wordpress. - -**4ª Pauta - Levantamento de requisitos** - -Foram confirmados alguns requisitos que ainda estavam em análise para serem adicionados ao escopo do projeto, os principais a serem discutidos foram os de envio de emails e personalização dos formulários. Além da análise de similares que continham algumas funcionalidades discutidas. - -### 4. Considerações finais - -A reunião se encerrou às 20:50. \ No newline at end of file diff --git a/docs/atas/ata-reuniao6.md b/docs/atas/ata-reuniao6.md deleted file mode 100644 index 0d9518ec..00000000 --- a/docs/atas/ata-reuniao6.md +++ /dev/null @@ -1,30 +0,0 @@ -### ATA DE REUNIÃO - SPRINT 16 - -11/07/2024 - -**Redator:** Max Rohrer - -### 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 20:25 - -### 3. Pautas da reunião - -**1ª Pauta - Feedback do cliente sobre o projeto** - -O cliente analisou o atual estado do projeto, foi comentado sobre o produto estar bem encaminhado e contendo as funcionalidades básicas necessárias para o comprimento do plugin de forma primária. - -**2ª Pauta - Revisão dos requisitos** -Foi discutido uma abordagem diferente em relação aos campos de serviço e também da personalização dos marcadores. Além disso, o cliente indicou a necessidade do plugin conseguir trabalhar com ao menos 1000 pontos cadastrados. - -**3ª Pauta - Ajustes da gitpage** -O cliente recomendou que a gitpage possuíse uma lista com possíveis objetivos que poderiam ser adicionados dentro do plugin no futuro. - -### 4. Considerações finais - -A reunião se encerrou às 20:55. \ No newline at end of file diff --git a/docs/backlog.md b/docs/backlog.md deleted file mode 100755 index 7f9fed5e..00000000 --- a/docs/backlog.md +++ /dev/null @@ -1,179 +0,0 @@ -# **Backlog** - -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. - - -## Épicos -| 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 | EP02 | -| FT03 | Georreferenciamento dos estabelecimentos/serviços| EP01 | - - -## User Story - -| ID | Eu como | Desejo | De modo que | FEATURES | -|:-------:|:--------------:|:-----------------:|:-----------:|:----------:| -| TS00 | Dev | Entender o funcionamento do wordpress e plugins | Eu consiga implementar uma arquitetura de um plugin | FT00 | -| TS01 | Dev | Entender sobre como utilizar o openstreetmap em JS | Eu consiga utilizar as ferramentas da API para criar mapas | FT00 | -| TS02 | Dev | Que o plugin possa ser utilizado por qualquer site que utilize o WordPress | O plugin possa ser utilizado por outras pessoas e/ou sites que se interessem por essa funcionalidade | FT00 | -| TS03 | Dev | Entender sobre a comunicação e manipulação do banco de dados do admin | O armazenamento dos formulários funcione corretamente | FT00 | -| TS04 | Dev | Entender sobre as funcionalidades que o WordPress oferece | Eu consiga estruturar de forma correta o código do plugin | FT00 | -| US00 | Administrador | Adicionar um formulário em qualquer página do meu site | Os usuários possam enviar os estabelecimentos/serviços | FT01 | -| US01 | Usuário | Enviar um formulário | Seja enviado informações relevantes sobre os locais amigáveis a comunidade LGBTQ+ | FT01 | -| US02 | Usuário | Ter um mapa juntamente com o formulário | Eu consiga marcar no mapa a localização do estabelecimento | FT01 | -| US03 | Usuário | Iniciar o mapa do formulário com minha localização | Seja mais fácil me situar dentro do mapa | FT01 | -| US04 | Usuário | Buscar a minha localização por meio de texto | Facilite o manuseio do mapa | FT01 | -| US05 | Usuário | Poder alterar a marcação dentro do mapa | Eu não precise estar fisicamente no estabelecimento que eu desejo apresentar no formulário | FT01 | -| US06 | Administrador | Enviar um e-mail ao usuário ao ele enviar suas respostas do formulário | O usuário tenha ciência de que suas respostas foram recebidas | FT01 | -| US07 | Administrador | Filtrar formulários enviados com conteúdo indesejado |O banco de dados seja o mais preservado | FT01 | -| 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 | 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 | -| US15 | Administrador | Um mapa na interface do administrador | Veja visualmente todos os formulários já aprovados | FT02 | -| US16 | Administrador | Poder ter uma maior interação entre o mapa da interface do administrador e os formulários | Possa acessar o formulário através do marcador no mapa | FT02 | -| US17 | Usuário | Todos os locais aprovados estejam marcados no mapa | Possa ter uma noção de locais seguros perto de mim | FT01 | -| US18 | Administrador | Excluir os formulários | Limpar o banco de dados de formulários indesejados ou nocivos | FT02 | -| US19 | Administrador | Os formulários sejam divididos em diferentes tabelas de acordo com o seu status | Tenha uma divisão clara entre os formulários aprovados, negados e pendentes | FT02 | -| US20 | Administrador | Implementar ferramentas de ordenação da interface do administrador | A tabela contendo os formulários esteja organizada de acordo com minha vontade | FT02 | - -## 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 | -|:----------:|:------:|:--------------------:|:-------------------------:| -| 12/03/2024 | 0.1.0 | Criação do plugin protótipo (Plugin teste) | @WillxBernardo | -| 14/03/2024 | 0.2.0 | Funcionalidade de criação da tabela no BD | @WillxBernardo | -| 18/03/2024 | 0.3.0 | Adicionando formulário a tela do plugin | @WillxBernardo | -| 18/03/2024 | 0.4.0 | Adicionando mapa no formulário (Overleaf)| @WillxBernardo | -| 20/03/2024 | 0.4.0 | Mapa sendo iniciado na localização do usuário| @Max-Rohrer20 | -| 26/03/2024 | 0.4.0 | Adição de interface de administração no painel WordPress| @Max-Rohrer20 | -| 26/03/2024 | 0.5.0 | Adição da tabela com os formulários na interface | @Max-Rohrer20 | -| 29/03/2024 | 0.5.1 | Bugfix: Login no wordpress| @WillxBernardo | -| 02/04/2024 | 0.5.2 | Bugfix: Erro ao adicionar o admin menu (Interface)| @WillxBernardo | -| 02/04/2024 | 0.5.3 | Bugfix: Erro ao se conectar ao banco de dados do wordpress| @WillxBernardo | -| 02/04/2024 | 0.5.4 | Bugfix: Erro ao excluir formulários na interface| @WillxBernardo | -| 02/04/2024 | 0.5.5 | Bugfix: Redirecionamento após o envio de formulário| @WillxBernardo | -| 07/04/2024 | 0.5.6 | Bugfix: Adição dos formulários enviados no Banco de dados | @WillxBernardo | -| 09/04/2024 | 0.6.0 | Adição de novos campos no formulário | @WillxBernardo | -| 10/04/2024 | 0.7.0 | Adicionando funcoes de aprovar e rejeitar na interface | @WillxBernardo | -| 11/04/2024 | 0.8.0 | Adicionando funcionalidades de navegação via botão | @MarcosViniciusG | -| 11/04/2024 | 0.9.0 | Adição das tabelas de Formulários Aprovados e Negados | @Max-Rohrer20 | -| 11/04/2024 | 0.10.0 | Funcionalidades nos botões de aprovar e negar | @Max-Rohrer20 | -| 11/04/2024 | 0.10.1 | Bugfix: Corrigindo formatação das tabelas do painel de administração| @Max-Rohrer20 | -| 12/04/2024 | 0.11.0 | Botões de validação na interface do admin| @WillxBernardo | -| 13/04/2024 | 0.12.0 | Botão ver mais do campo descrição da interface| @Punkrig | -| 13/04/2024 | 0.12.1 | Bugfix: Envio de formulário sem localização| @Punkrig | -| 14/04/2024 | 0.13.0 | Plotagem dos formulários em status aprovado nos mapas| @WillxBernardo | -| 16/04/2024 | 0.14.0 | Botões de ordenação em ordem alfabética no campo nome| @Max-Rohrer20 | -| 16/04/2024 | 0.15.0 | Popups nos marcadores dos mapas| @WillxBernardo | -| 16/04/2024 | 0.16.0 | Mapa na interface do administrador | @MarcosViniciusG | -| 17/04/2024 | 0.17.0 | Tipo de serviço 'outro' no formulário| @guslnhm | -| 18/04/2024 | 0.18.0 | Destaque na linha da tabela após clique em marcador| @MarcosViniciusG | -| 18/04/2024 | 0.19.0 | Popups contendo informações sobre o local| @Max-Rohrer20 | -| 18/04/2024 | 0.20.0 | Botão ver menos no campo de descrição da tabela| @Punkrig | -| 19/04/2024 | 0.20.1 | Bugfix: Armazenamento dos formulários com o tipo de serviço 'outro'| @guslnhm | -| 19/04/2024 | 0.21.0 | Mecanismo de busca nos mapas| @WillxBernardo | -| 23/04/2024 | 0.21.1 | Bugfix: Formulários com o tipo de serviço predefinidos| @guslnhm | -| 23/04/2024 | 0.22.0 | Ordenação dos campos de e-mail e data e hora da interface do admin| @Max-Rohrer20 | -| 23/04/2024 | 0.22.1 | Bugfix: Ordenação do campo de data e hora| @Max-Rohrer20 | -| 23/04/2024 | 0.22.1 | Bugfix: duplicacao dos resultados nos campos de busca dos mapas| @WillxBernardo | -| 23/04/2024 | 0.22.2 | Bugfix: Campo vazio no formulario | @WillxBernardo | -| 01/05/2024 | 0.23.0 | Adicionando resultados limitados a quantidade e botao ver mais | @WillxBernardo | -| 02/05/2024 | 0.23.1 | Bugfix: interface recarrega e não mostra mais o marcador excluido| @MarcosViniciusG | -| 02/05/2024 | 0.24.0 | Funcionalidade de ver mais e ver menos resultados | @WillxBernardo | -| 09/05/2024 | 0.25.0 | Envio de e-mail para o administrador do site | @Max-Rohrer20 | -| 10/05/2024 | 0.26.0 | Filtro por status | @MarcosViniciusG | -| 16/05/2024 | 0.27.0 | Filtro por nome | @MarcosViniciusG | -| 16/05/2024 | 0.28.0 | Filtro por serviço | @MarcosViniciusG | -| 16/05/2024 | 0.28.0 | Filtro por serviço | @MarcosViniciusG | -| 16/05/2024 | 0.29.0 | Envio de e-mail para as mudanças de status dos formulários | @Max-Rohrer20 | -| 16/05/2024 | 0.30.0 | Contador de resultados na interface do administrador | @MarcosViniciusG | -| 16/05/2024 | 0.31.0 | Notificação para acões do administrador | @Max-Rohrer20 | -| 17/05/2024 | 0.31.1 |Bugfix: Botão de confirmação não funciona para todos os formulários|@MarcosViniciusG | -| 22/05/2024 | 0.31.2 | Bugfix: Criação do BD ao ativar o plugin | @WillxBernardo | -| 05/06/2024 | 0.31.3 | Bugfix: Apenas o primeiro formulário na página do admin é modificado| @MarcosViniciusG | -| 05/06/2024 | 0.31.4 | Bugfix: Filtrando caracteres especiais em alguns campos| @Punkrig | -| 07/06/2024 | 0.31.5 | Bugfix: Não funcionamento do destaque de linha nas tabelas| @MarcosViniciusG | -| 17/06/2024 | 0.32.0 | Feat: Adição de localização de endereço a partir da Latitude e Longitude| @Max-Rohrer20 | -| 21/06/2024 | 0.33.0 | Feat: Tela de edição na interface do administrador| @WillxBernardo | -| 25/06/2024 | 0.33.1 | Bugfix: Inicializacao dos campos de latitude e longitude| @WillxBernardo | -| 27/06/2024 | 0.33.2 | Bugfix: corrigido a estilização de elementos HTML fora do escopo do plugin| @MarcosViniciusG | -| 28/06/2024 | 0.33.2 | Bugfix: Correção do css do pop-up para corrigir a linha que estava ficando sobreposta| @Max-Rohrer20 | -| 03/07/2024 | 0.33.3 | Bugfix: atualizado os testes PHP para mockar a função de conseguir a rua e cidade (novamente novamente)| @MarcosViniciusG | -| 03/07/2024 | 0.33.4 | Bugfix: a cidade e a rua são atualizadas quando a localização é editada no formulário| @MarcosViniciusG | -| 03/07/2024 | 0.33.5 | Bugfix: Modificação do conjunto de testes da tabela para se adaptar as mudanças realizadas na tabela| @MarcosViniciusG | -| 11/07/2024 | 0.34.0 | Feat: Adicionando funcionalidade de fullscreen nos mapas | @WillxBernardo | -| 11/07/2024 | 0.34.1 | Style: Adicionando estilização do botão de tela cheia | @WillxBernardo | -| 15/07/2024 | 0.35.0 | Dev: Adicionando script para preenchimento do banco de dados | @WillxBernardo | -| 19/07/2024 | 0.35.1 | Bugfix: caracteres | @Punkrig | -| 29/07/2024 | 0.35.2 | Teste: caracteres | @Punkrig | -| 02/08/2024 | 0.36.0 | Feat: Front-end da paginação da tabela dos formulários | @MarcosViniciusG | -| 06/08/2024 | 0.37.0 | Feat: Mecanismos de sinalizacão de tabela selecionada | @WillxBernardo | -| 08/08/2024 | 0.38.0 | Feat: Adicão do bloco do plugin no editor de blocos do wordpress | @WillxBernardo | -| 10/08/2024 | 0.39.0 | Feat: adicionado a lógica do backend da paginação | @MarcosViniciusG | -| 11/08/2024 | 0.39.1 | Style: butões da página admin; - Alinhando os butões da página admin | @Punkrig | -| 12/08/2024 | 0.40.0 | Feat: Arquivo de desinstalacao do plugin | @WillxBernardo | -| 12/08/2024 | 0.40.1 | Feat: retirado os testes JavaScript pois eles não refletem mais as necessidades do código atualmente | @MarcosViniciusG | -| 13/08/2024 | 0.41.0 | Feat: Adicionando corpo do filtro por servico no mapa | @WillxBernardo | -| 13/08/2024 | 0.41.1 | Feat: Funcionalidades para uso do filtro na pagina | @WillxBernardo | -| 13/08/2024 | 0.41.2 | Feat: Filtros de marcadores no mapa da tela inicial | @WillxBernardo | -| 13/08/2024 | 0.41.3 | Refactor: Alterando nomes do BD em inglês para português | @WillxBernardo | -| 14/08/2024 | 0.41.4 | Bugfix: adicionado o parâmetro --passWithNoTests para poder passar o testes automatizados JS sem a presença de testes | @MarcosViniciusG | -| 14/08/2024 | 0.41.5 | Dev: Atualizando testes para novo BD | @WillxBernardo | -| 15/08/2024 | 0.42.0 | Refactor: Foram criadas funções para verificar se as entradas dos inputs dos formulários está correta | @MarcosViniciusG | -| 15/08/2024 | 0.42.1 | Feat: Foram implementados alertas visuais nos campos do formulário | @MarcosViniciusG | -| 15/08/2024 | 0.42.2 | Bugfix: Corrigido bug onde alguns emails válidos não eram aceitos | @MarcosViniciusG | diff --git a/docs/contato.html b/docs/contato.html deleted file mode 100644 index 33b8ebb2..00000000 --- a/docs/contato.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - - - - - - - - - - Lgbtq+ Connect - - - - - - - - - - - - - - - - - -
- -
-
- -
-
- -
- - - -
-
-
-
-
-
-

- Request A Call back -

-
-
-
- -
-
- -
-
- -
-
- -
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/.nojekyll b/docs/docsify/.nojekyll similarity index 100% rename from docs/.nojekyll rename to docs/docsify/.nojekyll diff --git a/docs/index.html b/docs/index.html index 62ffed74..f6f38a65 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,6 +31,16 @@ + + +
@@ -60,7 +70,7 @@
- + Documentação
diff --git a/docs/index.md b/docs/index.md deleted file mode 100755 index 505275e2..00000000 --- a/docs/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -hide: - - navigation ---- - -# **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! - -## Sobre o Projeto - -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. - - -## 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 - - - - - - - - - -
- - -
Maximiliano Rohrer Martins Junior - -
-
-
- - -
William Bernardo da Silva - -
- -
-
- - -
Igor Brandão Costa
-
-
- - -
Gustavo Linhares Lima - -
-
-
- - -
Marcos Vinicius Gündel da Silva - -
-
-
- - - diff --git a/docs/preparandoambiente.md b/docs/preparandoambiente.md deleted file mode 100755 index 3709d7eb..00000000 --- a/docs/preparandoambiente.md +++ /dev/null @@ -1,66 +0,0 @@ -# **Preparando ambiente para desenvolvimento** - -Os comandos listados a seguir são para dispositivos linux. - -- Instalar o curl -``` -sudo apt update && sudo apt install curl -``` - -- Instalar o docker (comando) -``` -curl https://get.docker.com | bash -``` - -- (OPCIONAL) - Para não ser necessário utilizar o *sudo* antes das instruções do docker execute: - -``` -sudo groupadd docker && sudo gpasswd -a $USER docker -``` - -- Utilize o arquivo **docker-compose.yaml** para iniciar os containers. (caso não queira executar os containers em segundo plano remova o *-d* ) -``` -docker compose up -d -``` - -- Para vizualizar os containers em execução: - -``` -docker compose ps -``` - -- Em um navegador acesse as respectivas portas: - -

- Wordpress: - localhost:8082
- PhpMyAdmin: - localhost:8083 -

- - -> No wordpress faça a configuração incial para acessar o wordpress - - -> No PhpMyAdmin faça login com **Usuário: Admin** e **Senha: Admin** - -- 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: - - localhost:8082/wp-admin - -- 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: **[lgbtq_connect]** - -## **Preenchimento do banco de dados automático** - -- Para execução do script de preenchimento certifique-se da tabela 'lc_formulario' estar vazia. - -- Os dados inseridos tem a finalidade apenas para testes de estresse, não contendo dados reais. - -- Para execução basta apenas acessar: http://localhost:8082/wp-content/plugins/plugin-prototipo/preenche_bd.php/ - -- Verifique a inclusão das linhas acessando - phpMyAdmin \ No newline at end of file diff --git a/docs/releases/release1.md b/docs/releases/release1.md deleted file mode 100644 index dd94b601..00000000 --- a/docs/releases/release1.md +++ /dev/null @@ -1,51 +0,0 @@ -# **Release 1** - -## **Sprint 0** - -- Nessa sprint o objetivo foi o estudo sobre o funcionamento do wordpress e estudo sobre a documentação do desenvolvimento de plugins. - -- Foi iniciada uma análise sobre os requisitos e escopo do projeto, mesmo sem essas informações claras no primeiro momento. - -## **Sprint 1** - -- Preparação do ambiente de desenvolvimento docker, utilizamos o docker compose para conter os containers: Wordpress, PhpMyAdmin e MySQL. - -- Início do estudo sobre o funcionamento do Leaflet para o georreferenciamento dos locais/serviços amigáveis a comunidade LGBTQ+. - -- Início dos testes de plugins básicos para conexão com wordpress. - -## **Sprint 2** - -- Início de produção do plugin, com implementação de cabeçalho para a documentação padrão do wordpress - -- O objetivo principal nessa sprint é de adicionar um formulário que envia informações com o banco de dados (ainda configurado manualmente). - -- Foi adicionado com a biblioteca do leaflet o mapa + a funcionalidade de marcação no mapa. - -## **Sprint 3** - -- Início da documentação do projeto sendo adicionado alguns artefatos na gitpages: Home, Preparando ambiente de desenvolvimento, Atas de reunião e Backlog do produto. - -- Adição da funcionalidade Iniciar o mapa na localização do usuário, adição de alguns actions e alguns testes de ferramentas de busca que infelizmente se mostraram inviáveis em um primeiro momento. - -- Criação da interface de adminstração dos formulários - -- Criação da tela inicial do wireframe no plugin. - -## **Sprint 4** - -- Adição de artefatos na documentação: Roadmap, Storymap e wireframe. - -- Criação da funcionalidade de mostrar os formulários enviados na interface de administração. - -- Início da estilização do plugin em relação a página, levando em consideração o cuidado para interferência -mínima em estilização de outras funcionalidade do wordpress. - -## **Sprint 5** - -- Reestruturação do código base do plugin, para melhor desenvolvimento e implementações futuras. - -- Adição de artefatos na documentação: Arquitetura, requisitos, tutorial e documento de releases. - -- Atualização de artefatos pois foram levantados novos requisitos com o cliente. - diff --git a/docs/releases/release2.md b/docs/releases/release2.md deleted file mode 100644 index c31ad6a3..00000000 --- a/docs/releases/release2.md +++ /dev/null @@ -1,81 +0,0 @@ -# **Release 2** - -## **Sprint 6** - -O objetivo inicial dessa sprint é a implentação de algumas funcionalidades, resolução de bugs e atualização da documentação, além da análise sobre testes, estudo sobre segurança e configuração do ambiente de produção (VM). - - -|Descrição| Nº issue| -|---------|---------| -|Remodelando o banco de dados do projeto|#47| -|Adição da página de confirmção|#52 -|Testando o formulário do plugin pelo Smartphone|#57| -|Estudo sobre a implementação de testes| #61| -|Resolvendo bug do template de issue| #62| -|Configuração do ambiente de desenvolvimento (VM)| #63| -|Adicionar os novos campos presentes no BD no formulário | #65| -|Ajuste no campo de descrição na interface do admin | #66| -|Criação das funcionalidade de alteração do status | #67| -|Nova organização dos formulários na interface | #68| -|Ajuste na tela de confirmação de envio do formulário | #69| -|Estudo sobre envio de emails | #71| -|Plotagem dos locais cadastrados nos mapas | #73| - - -## **Sprint 7** - -Nessa sprint temos como objetivo a adição de funcionalidade tanto na interface e nas telas do plugin. Além da continuação da configuração do ambiente de produção (VM), documentação, estudo de teste e funcionalidade de envio de emails. - - -|Descrição| Nº issue| -|---------|---------| -|Criação do wireframe da interface |#64| -|Implementação de ferramentas de ordenação nas tabelas do painel de administração |#72| -|Adição de um sub menu dentro do menu do LGBTQ+ Connect |#75| -|Atualização da documentação do projeto |#76| -|Campo para adição de um novo tipo de serviço |#77| -|Resolvendo bug no envio de formulários sem marcador|#78| -|Adicionando a licença na raíz do projeto|#79| -|Adicionando funcionalidade de popup nos marcadores dos mapas|#80| -|Adicionando novo texto no popup dos mapas|#81| -|Interação com os marcadores no mapa da página de administrador|#82| -|Adicionar feature de busca no mapa|#84| - -## **Sprint 8** - -Nessa sprint o objetivo é o tratamento de bugs que persistem no uso do plugin, desenvolvimento do desing das telas e interface do administrador para melhor experiência do usuário. Durante essa sprint também continuará a preparação do ambiente de produção (VM) do projeto. Além da adição de algumas funcionalidades restantes. - -|Descrição| Nº issue| -|---------|---------| -|Modelagem de banco de dados para o projeto |#70| -|Resolvendo bug no envio de formulários com tipo de serviços pré-definidos |#83| -|Resolver bug do duplo clique nos botões de pesquisa |#85| -|Análise sobre os códigos de mapa |#87| -|Atualização do arquivo .zip do plugin|#88| -|Alteração da visualização da data e hora nas tabelas |#89| -|Estilização dos campos de busca |#90| -|Ordenação das tabelas por e-mail e data e hora |#91| -|Adicionando feature de ver mais nos campos de descrição|#93| -|Adição das sprints 7 e 8 |#94| -|Trabalho visual nos resultados da busca |#97| -|Adicionar guia de contribuição no projeto |#101| -|Adicionar código de conduta no projeto |#102| -|Adicionar políticas de segurança do projeto |#103| - - -## **Sprint 9** - -O objetivo dessa sprint é o tratamento de algumas funcionalidade (features) adicionadas anteriormente, polindo e melhorando a experiência dessas ferramentas. Também é necessário o tratamento de alguns erros e bugs em algumas funcionalidades. Criação da funcionalidade de notificação na interface do administrador, e possíveis outras necessárias para a segunda release. - -|Descrição| Nº issue| -|---------|---------| -|Configuração do ambiente de desenvolvimento (VM) |#63| -|Desenvolvimento de visual para os popups dos mapas |#86| -|Criação do wireframe dos popups |#95| -|Tratamento dos resultados da API de busca |#98| -|Tratamento após a exclusão de um formulário com status aprovado |#105| -|Adição da Ata de reunião 05 |#108| -|Refatoração dos arquivos de estilização do projeto |#109| -|Atualização nas ações da interface do administrador |#111| -|Ajustes dos botões de ver mais ou menos das buscas |#113| -|Adicionando novos botões no painel de administração |#114| diff --git a/docs/releases/release3.md b/docs/releases/release3.md deleted file mode 100644 index 11411742..00000000 --- a/docs/releases/release3.md +++ /dev/null @@ -1,110 +0,0 @@ -# **Release 3** - -## **Sprint 10** - -O objetivo dessa sprint é o início do desenvolvimento dos envios de emails em dois momentos: Quando um formulário é enviado e quando um formulário é Aceito/Recusado, sendo o segundo um pouco mais complexo pois necessita de algumas avaliações sobre alterações rápidas/continuas nos status de alguns formulários. Também é necessário o início dos testes do plugin e a criação do ciclo de CI/CD do projeto visando a automação de processos. O início de um tratamento visual para a interface, o desenvolvimento de um wireframe trabalhado com o design relacionado ao tema do projeto e a implementação desse design na interface. Também se mostra necessário a atualização da documentação do projeto (GitPages). - - -|Descrição| Nº issue| -|---------|---------| -| Adição de uma notificação após ações do administrador|#96| -| Desenvolvimento do wireframe da interface do administrador |#115| -| Envio de emails após a submissão de algum formulário |#116| -| Atualização da documentação |#117| -| Desenvolvimento de testes do plugin |#118| -| Criação dos filtros de tabelas na interface |#119| - - -## **Sprint 11** - -Nesta sprint, estamos focando na continuação dos trabalhos iniciados na sprint 10. Isso inclui várias atividades como o envio de e-mails para o usuário que submeteu o formulário após a ação do administrador, o tratamento dos dados enviados durante o uso do plugin, a criação de testes para o plugin, a adição de filtros na interface para classificar os formulários por status, a análise dos comportamentos do plugin em dispositivos móveis e a atualização da documentação. Estamos comprometidos em avançar em todas essas áreas para garantir o progresso contínuo do projeto e aprimorar a experiência do usuário. - - -|Descrição| Nº issue| -|---------|---------| -| Desenvolvimento de testes|#124| -| Tratamento de dados enviados durante o uso do plugin|#125| -| Envio de emails para o usuário que enviou o formulário (após a ação do admin)|#126| -| Adição de filtros na interface por status de formulario|#127| -| Análise sobre os comportamentos do plugin em dispositivos mobile|#128| - -## **Sprint 12** - -O objetivo principal dessa sprint é a reestruturação dos códigos do plugin. Durante a tentativa de criação de testes para o plugin mostrou-se necessário a reestruturação dos códigos (Php e JavaScript) pois estão muito integradas com os componentes do wordpress, inviabilizando a criação de testes. Também durante essa sprint será trabalhada a documentação do projeto e o desenvolvimento da gitpages para identificação visual com o plugin. - -|Descrição| Nº issue| -|---------|---------| -| Reestruturação das funções de conexao com o banco de dados DEV|#138| -| Criação dos testes das funções de conexão com o banco de dados|#140| -| Reestruturação das funções da interface do administrador|#141| -| Reestruturação das funções de envio e recebimento de formulário|#142| -| Estudo de testes unitários em JavaScript usando Jest|#143| -| Trazer a identidade visual do produto para a documentação|#145| -| Criação dos testes para as funções da interface do administrador (PHP)|#148| -| Customizações visuais na documentação|#149| - - -## **Sprint 13** - -O objetivo principal dessa sprint é o início do desenvolvimento da tela de edição de formulários na interface, atualização da documentação após a transição da ferramenta Gitpages para Docsify e a revisão dos códigos JavaScript para criação de testes e correção dos erros de console que os navegadores indicam. - -|Descrição| Nº issue| -|---------|---------| -| Remoção do bug nas telas do plugin |#74| -|Atualização da documentação do projeto |#152| -| Pesquisa para a adição da funcionalidade de buscar endereço a partir das coordenadas |#154| -| Corrigir o erro do gráfico da arquitetura na documentação do Docsify |#155| -| Implementação de testes para o código JS da página do administrador |#156| -| Implementação de testes para o código JS do shortcode |#157| -| Criação da tela básica de edição na interface do administrador |#158| -| Funcionalidades de exibição dos dados do formulário nos campos da tela de edição |#159| - -## **Sprint 14** - -O objetivo dessa sprint é a continuação do desenvolvimento da ferramenta de edição dos formulários, atualização da documentação, desenvolvimento do visual da interface do administrador, adição de um marcador personalizado nos mapas e desenvolvimento do desing da tela de edição. - -|Descrição| Nº issue| -|---------|---------| -| Adição do mapa na tela edição + funcionalidade de busca|#160| -| Atualização dos artefatos da documentação|#162| -| Desenvolvimento do desing da interface|#163| -| Desenvolvimento do design da tela de edição|#164| -| Marcador personalizado|#166| -| Campo de busca no mapa da edição |#167| -| Resultados repetidos na busca (tela de edição)|#168| -| Salvar alterações na tela de edição |#169| -| Implementação de testes para o código JS da página do administrador e refatoração parcial do código JS do shortcode|#171| - - -## **Sprint 15** - -O objetivo principal dessa sprint é a finalização da tela de edição para disponibilização da funcionalidade no ambiente de produção. Além de alguns ajustes no desenvolvimento do front end da tela de edição de acordo com o wireframe disponibilizado, resolução de bugs da tela de edição, criação do teste para a funcionalidade de editar os dados do formulário, finalizar transição da gitpages para docsify na documentação, adição da Sprint 15 na documentação. - -|Descrição| Nº issue| -|---------|---------| -| Desenvolvimento do front end da tela de edição |#173| -| Criação do teste para a funcionalidade de editar os dados do formulário|#175| -| Finalizar transição da gitpages para docsify na documentação|#176| -| Adição da Sprint 15 na documentação |#177| - - -## **Sprint 16** - -O objetivo dessa sprint é o inicio do polimento do plugin, análise de comportamentos em ambiente de produção e ajustes em na interface do administrador. - -|Descrição| Nº issue| -|---------|---------| -| Criação dos marcadores personalizados |#186| -| Tratamento de dados na tela de edição |#187| -| Alerta visual nos campos inválidos |#188| -| Botão para tela cheia nos mapas |#189| - - -## **Sprint 17** - - -|Descrição| Nº issue| -|---------|---------| -| Melhoria na landing page da documentação |#191| -| Script para preenchimento do banco de dados |#192| -| Melhoria do bloco de ações da tabela do administrador |#193| \ No newline at end of file diff --git a/docs/roadmap.md b/docs/roadmap.md deleted file mode 100644 index 8db33c7a..00000000 --- a/docs/roadmap.md +++ /dev/null @@ -1,3 +0,0 @@ -# **Roadmap** - - \ No newline at end of file diff --git a/docs/storymap.md b/docs/storymap.md deleted file mode 100644 index 50b025b4..00000000 --- a/docs/storymap.md +++ /dev/null @@ -1,3 +0,0 @@ -# **Storymap** - - diff --git a/docs/tutorialmarcadores.md b/docs/tutorialmarcadores.md deleted file mode 100644 index 3b7d3e78..00000000 --- a/docs/tutorialmarcadores.md +++ /dev/null @@ -1,96 +0,0 @@ - -# Adicionando Novos Tipos de Serviço e Marcadores Personalizados -## Introdução -Para garantir a escalabilidade e a flexibilidade do plugin "LGBTQ+ Connect", é importante que novos tipos de serviço possam ser adicionados facilmente, com marcadores personalizados para representar esses serviços no mapa. Este tutorial orientará você, em nível de código, sobre como realizar essa implementação. - -## Passos para Adicionar Novos Tipos de Serviço -### 1. Adicionando um Novo Tipo de Serviço no Formulário -Primeiramente, é necessário garantir que o novo tipo de serviço seja armazenado corretamente na tabela do banco de dados. A tabela que armazena os tipos de serviço é referenciada pela coluna "servico". -Se você deseja adicionar um novo serviço certifique-se de que ele seja inserido na tabela correspondente, no nosso exemplo vamos adicionar um serviço chamado "Apoio Jurídico". - -- 1.1 - Comece primeiro selecionando uma imagem para servir como marcador, recomendamos usar o mesmo modelo de marcadores que já estão no plugin e mudando apenas a cor dele e o ícone no meio do marcador para identificação do tipo de serviço -
- Tutorial 1.1 -
- -- 1.2 - Agora você irá acessar o arquivo "index.html" e ir até a div "servicoPacote" - -
- Tutorial 1.1 -
- -- 1.3 - Adicione o tipo de serviço como uma option onde o valor é o nome do tipo de serviço em minúsculo, no nosso caso será apoio jurídico -
- Tutorial 1.2 -
-- 1.4 - Com isso já teremos o novo tipo de serviço aparecendo no seu plugin e sendo adicionado ao banco de dados quando ele for selecionado - -
- Tutorial 1.3 -
- -### 2. Associando Imagens Personalizadas aos Novos Serviços -Para que um novo tipo de serviço tenha um marcador personalizado no mapa, você precisará associar uma imagem ao serviço recém-criado. Isso é feito diretamente na lógica que define os marcadores no JavaScript. - --2.1 - Adicione a imagem dentro da pasta imgs dentro da pasta assets do plugin - -
- Tutorial 2.1 -
- -- 2.2 - Vá até index.php e encontre o array "$marcadores" que está na função "enfileirar_scripts" - -
- Tutorial 2.2 -
- -- 2.3 - Você irá adicionar dentro do array "$marcadores" o valor com o nome do seu novo tipo de serviço e linkar ele diretamente com a imagem que foi feita para representa-lo - -
- Tutorial 2.3 -
- -- 2.4 - Repita esse mesmo processo no array "$marcadores" na função "enfileirar_scripts_admin - -
- Tutorial 2.4 -
- -- 2.5 - Com isso temos o marcador já aparecendo juntamente dos marcadores antigos - -
- Tutorial 2.5 -
- -### 3. Adicionano o novo tipo de serviço ao filtro -Com o novo tipo de serviço adicionado e sua imagem definida e também adicionada só precisamos agora adicionar o novo tipo de serviço ao filtro para que você possa filtrar apenas aquele tipo de serviço se for necessário - --3.1 - Acessa o arquivo script.js e vá até a função "filtrarservicos": - -
- Tutorial 3.1 -
- --3.2 - Adicione na constante "servicosPreDefinidos" o novo tipo de serviço com o mesmo valor que adicionamos no passo 1.3 - -
- Tutorial 3.2 -
- --3.3 - Agora vá até o arquivo styles.css que está na pasta styles do plugin - -
- Tutorial 3.3 -
- --3.4 - Defina um novo ".name_servico" com o mesmo valor do passo 1.3 e defina um accent-color com a cor desejada - -
- Tutorial 3.4 -
- --3.5 - Com isso temos o novo tipo de serviço colocado separadamente dentro do filtro por tipo de serviço - -
- Tutorial 3.5 -
\ No newline at end of file diff --git a/docs/wireframe.md b/docs/wireframe.md deleted file mode 100644 index 43a2451a..00000000 --- a/docs/wireframe.md +++ /dev/null @@ -1,45 +0,0 @@ -# **Wireframes** - -## **Plugin** - - -## **Painel de administração** - - -## **Pop-up dos marcadores de locais já aprovados** - - -## **Marcador Padrão do plugin** -
- Marcador Padrão do Plugin -
- -## **Marcador Personalizado Para Bares/Restaurantes** -
- Marcador Personalizado para Bares e Restaurantes -
- -## **Marcador Personalizado Para Entretenimento** -
- Marcador Personalizado para Entretenimento -
- -## **Marcador Personalizado Para Beleza** -
- Marcador Personalizado para Beleza -
- -## **Marcador Personalizado Para Academia** -
- Marcador Personalizado para Academia -
- -## **Marcador Personalizado Para Ensino** -
- Marcador Personalizado para Ensino -
- -## **Marcador Personalizado Para Hospedagem** -
- Marcador Personalizado para Hospedagem -