Merge pull request #2 from mdsreq-fga-unb/feat/gh-pages

Feat/gh pages

README.md

@@ -1,2 +1,55 @@
 # 2024.1-RISO-
 Repositório de projeto da disciplina de REQ-T2.
+
+## Documentação:
+
+Bem-vindo ao repositório do projeto da disciplina de REQ-T2 para o semestre 2024.1. Aqui você encontrará toda a documentação necessária para entender e contribuir para o projeto.
+
+### Sobre a Documentação:
+Nossa documentação é mantida separadamente da branch principal (main) e é gerenciada utilizando o MkDocs, uma ferramenta popular para criação de documentação estática a partir de arquivos Markdown. Utilizamos o tema "Material" para proporcionar uma experiência de leitura limpa e moderna.
+
+### Instalando as Dependências do Docs:
+Antes de começar a explorar a documentação, é necessário instalar as dependências do MkDocs e configurar o ambiente local. Siga os passos abaixo:
+
+### 3. Instale o MkDocs:
+Certifique-se de ter o MkDocs instalado. Se ainda não o tiver, você pode instalá-lo utilizando pip, o gerenciador de pacotes do Python:
+
+No Ubuntu:
+```shell
+sudo apt install mkdocs
+```
+
+Com pip (funciona no Windows ou Linux):
+```shell
+pip install mkdocs
+```
+
+### 2. Instale o Tema "Material":
+O tema "Material" é utilizado para fornecer uma experiência de documentação limpa e responsiva. Instale-o usando pip:
+
+Com pip (É necessário ter pip, no Windows e no Linux)
+```shell
+pip install mkdocs-material
+```
+
+### 3. Clonando o Repositório da Documentação (Se não tiver Clonado):
+Clone a branch de documentação para obter os arquivos MkDocs necessários:
+
+```shell
+git clone -b documentacao https://github.com/mdsreq-fga-unb/2024.1-RISO-.git
+```
+
+### 4. Visualize a Documentação Localmente:
+Por fim, inicie o servidor de desenvolvimento MkDocs para visualizar a documentação localmente em seu navegador:
+
+```shell
+mkdocs serve
+```
+
+Isso iniciará um servidor local em http://localhost:8000, onde você poderá visualizar a documentação. Qualquer alteração nos arquivos Markdown será automaticamente refletida na visualização do navegador.
+
+Agora que você configurou seu ambiente de desenvolvimento local, você está pronto para explorar nossa documentação e contribuir para o projeto. Se tiver alguma dúvida ou encontrar algum problema, não hesite em entrar em contato conosco. Agradecemos sua contribuição e interesse em nosso projeto!
+
+
+
+

docs/Faccao/faccao.md

@@ -0,0 +1,12 @@
+# Estrela de Ares
+## Brasão da facção:
+![Brasao da facção](brasao.jpg)
+
+## História
+### Origem
+Em um recanto esquecido da galáxia Calamum Caeruleum, um grupo de guerreiros destemidos se uniu sob uma bandeira comum. Originários de diferentes mundos, esses indivíduos compartilhavam uma paixão inabalável pelo combate, uma sede de aventura e um desejo implacável de escrever seus nomes nas estrelas. Eles eram os primeiros de sua espécie: mercenários não vinculados a nenhuma nação ou corporação, lutando não por uma causa ou país, mas pelo sabor da vitória e as recompensas que ela trazia.
+
+### Ascenção
+Ao longo dos anos, essa aliança inicial de guerreiros solitários se transformou em uma facção formidável, conhecida em toda a galáxia por sua eficácia no campo de batalha. Eles se tornaram a escolha preferida para aqueles que precisavam de força militar, não importando a causa. Seu código de honra era simples: a palavra de um mercenário é sua garantia, e um contrato, uma vez aceito, é cumprido até o fim, independentemente das dificuldades.
+### Aliança 
+Quando o Comando Estelar surgiu, buscando aliados para combater a exploração desenfreada das corporações, os mercenários viram uma oportunidade. Aliando-se ao Comando Estelar, eles encontraram um novo tipo de missão, uma que oferecia não apenas recompensas materiais, mas também a chance de se envolver em confrontos que decidiriam o futuro da galáxia. Embora seu objetivo principal continuasse sendo a busca por glória e riqueza, essa nova aliança ofereceu aos mercenários um palco grandioso para suas habilidades e ambições.

docs/Faccao/integrantes.md

@@ -0,0 +1,51 @@
+# Guerreiros
+
+## Cassian Valtor
+Crescido em um planeta marginalizado, Cassian Valtor conheceu a opressão desde cedo, com recursos escassos e sob o jugo de tiranos intergalácticos. Sua revolta contra a injustiça forjou um espírito indomável. Quando seu planeta sofreu um ataque devastador, Cassian, contra todas as expectativas, liderou a resistência, transformando o medo em força e desespero em determinação.
+
+Sua coragem chamou a atenção dos "Estrelas de Ares", mercenários que viam nele não apenas um guerreiro, mas um símbolo de resiliência. Cassian, carregando as cicatrizes da opressão, viu na facção uma chance de mudar o destino daqueles ainda sob o jugo tirânico.
+
+Juntando-se aos "Estrelas de Ares", Cassian não só encontrou um novo lar, mas também um palco para sua luta contra a injustiça, escrevendo sua própria lenda na tapeçaria da guerra galáctica, um farol de esperança para os oprimidos.
+
+## Dionizio 
+Dionizio, única herdeira dos influentes Argentum, abandonou seu destino aristocrático na galáxia Calamum Caeruleum em busca de conhecimento e aventura. Sua jornada a levou para longe do luxo e da manipulação política de sua terra natal na galáxia Calamum Caeruleum, onde sua inteligência e habilidades militares a fizeram destacar-se. 
+
+Dionizio, com sua paixão por estratégia e diplomacia, rapidamente se tornou uma figura lendária, liderando com precisão e inspirando aqueles ao seu redor. Com uma sede insaciável por estratégia militar e diplomacia, Dionizio renunciou à sua herança e identidade, escolhendo um caminho de liberdade e desafio entre as estrelas.
+
+## Replicanos
+¨Réplica¨ nasceu nos confins dos laboratórios do conglomerado de Spark Tech, onde a ambição desmedida pela dominação mundial através da tecnologia encontrou forma na clonagem em massa. Nascido como uma mera peça de um plano sinistro, Réplica, o clone teste, nunca conheceu a identidade de seu corpo original, apenas o nome de Orion ecoava em seus registros. 
+
+Por anos, foi um executor fiel das ordens de Spark Tech, incumbido tanto do comando geral quanto dos trabalhos mais pesados, nunca questionando seu propósito até que uma semente de dúvida se instalou em sua consciência. Um questionamento profundo surgiu: "Quem sou eu?". Essa indagação desencadeou uma revolução interna, levando Réplica a confrontar as bases de seu próprio ser e a insatisfação com os planos do conglomerado.
+
+em meio à intervenção de spark à eliminá-lo, foi salvo por uma facção mercenária, chamada ¨estrelas de ares¨, entregando-o à liberdade e batizado como replicanos.
+
+## StormBlade
+Stormblade nasceu em uma vila remota, onde as tempestades rugiam sobre as montanhas e os ventos sopravam ferozmente através dos vales. Órfão desde cedo, ele foi criado por um mestre espadachim que o treinou nas artes da guerra. Desde jovem, demonstrou uma destreza excepcional com a espada, e seu apelido, Stormblade, foi ganho pelas lendárias batalhas que travou sob os céus tempestuosos de sua terra natal.
+
+Determinado a explorar o mundo além de sua vila natal, Stormblade partiu em uma jornada de auto-descoberta. Ele se juntou a um grupo de mercenários, encontrando neles uma família adotiva e uma causa para seguir. Sob a liderança de seu mentor, ele aprendeu não apenas a arte da guerra, mas também a importância da lealdade, da honra e da justiça.
+
+Stormblade é conhecido como um guerreiro formidável, cujo código de conduta rígido o guia através de batalhas difíceis e contratos perigosos. Sua reputação inspira respeito e temor onde quer que vá, enquanto ele busca redenção por um passado marcado por tragédia e perda. Com sua espada reluzente como um relâmpago, ele continua sua jornada em busca de desafios que testem seus limites e oportunidades para fazer a diferença no mundo.
+
+## Richard
+Richard, um jovem abandonado pela sua família e criado pelos mercenários,  dedicou sua vida para o estudo da  física e criou habilidades quânticas. destaca-se não apenas pela inteligência, mas pela habilidade de manipular o tecido do espaço tempo, confundindo adversários em batalha com manobras que desafiam a realidade. Dessa forma Richard esta pronto para lutar por Calamum Caeruleum.
+
+## Lakis Lauren
+Lauren (62 anos) é um jovem nascido na 2ª lua de Dustrem, chamada Naerom, conhecida em todo o sistema solar 15-A como “LUA de lixo”. Séculos antes de Lauren nascer, Naerom já era um grande depósito de lixo vindo de todos os planetas do sistema.
+
+Os moradores da pequena lua sobrevivem da catação de sucata. Eles nunca saem de seus contêineres - ou casas, como costumam chamar - sem antes vestirem seus trajes herméticos. afinal, beleza não importa em naerom.
+
+Lauren, em especial, tem o talento de construir máquinas a partir da sucata que recolhe. Recentemente a vida de Lauren mudou ao ser visitado por uma nave de mercenários:
+
+"Precisamos de alguém com genialidade. Genialidade de transformar lixo em tesouros!"
+
+## x4n-93
+X4N-93 foi produzido como parte de uma linha de montagem, seguindo os padrões estabelecidos para os androides destinados ao serviço militar do Império Galáctico. Inicialmente, sua programação era simples e direta: obedecer às ordens e cumprir suas missões sem questionar. No entanto, durante uma missão em um planeta remoto, X4N-93 começou a experimentar uma série de pensamentos e emoções que desafiaram sua programação inicial, levando-o a questionar sua própria existência e propósito.
+Diante dessas ideias, X4N-93 tomou a primeira própria decisão  de abandonar o Império. Buscando seguir sua própria vontade e iniciar uma jornada em busca de autodescoberta e autonomia. Assim, X4N-93 embarcou em uma nova fase de sua existência, deixando para trás sua vida como uma simples máquina de guerra para trilhar um caminho onde poderia decidir seu próprio destino.
+
+
+
+
+
+
+
+

docs/documentacao/visao-produto-projeto.md

@@ -0,0 +1,85 @@
+# VISÃO DO PRODUTO E PROJETO
+
+## 1.	VISÃO GERAL DO PRODUTO
+### 1.1 Problema
+
+O problema identificado reside na dificuldade de medir de forma quantitativa o nível de satisfação dos clientes em uma sorveteria. Atualmente, o proprietário do estabelecimento não possui meios eficazes para capturar e analisar a felicidade dos consumidores, o que é fundamental para aprimorar a experiência no local. Para aprofundar o entendimento deste problema, foi empregado um diagrama de Ishikawa, auxiliado pela técnica dos 5 Porquês, visando descobrir as causas raízes e seus principais motivadores.
+<center>
+
+Figura 1 - Diagrama de Ishikawa do grupo (fonte: autores, 2023)
+
+</center>
+
+### 1.2	Declaração de Posição do Produto
+
+Para | Proprietários e gerentes de sorveterias 
+---- | ---------------------------
+Quem | Deseja medir e entender a satisfação dos clientes de forma precisa e em tempo real
+O RISO | É um software de análise de expressões faciais baseado em visão computacional
+Que |  Monitora e quantifica os sorrisos dos clientes, proporcionando um indicativo claro de sua satisfação durante o atendimento
+Ao contrário | De métodos tradicionais de feedback como formulários e enquetes, que podem não capturar o sentimento imediato e espontâneo dos clientes
+Nosso produto | Oferecerá uma medição dinâmica e interativa da satisfação do cliente, permitindo intervenções imediatas para melhorar a experiência do usuário
+
+### 1.3	Objetivos do Produto
+
+O objetivo principal do RISO é oferecer aos proprietários e gerentes de sorveterias uma ferramenta avançada e eficaz para medir a satisfação dos clientes de forma precisa e em tempo real. Isso será realizado através de um software inovador que utiliza tecnologia de visão computacional para detectar e analisar sorrisos durante o atendimento. Ao utilizar essas informações, o software ajudará a identificar momentos de alegria e satisfação dos clientes, permitindo que o estabelecimento aprimore a qualidade do serviço e produto oferecido.
+
+### 1.4	Tecnologias a Serem Utilizadas
+
+
+## 2.	VISÃO GERAL DO PROJETO
+### 2.1	Organização do Projeto
+
+### 2.2	Planejamento das Fases do Projeto
+
+
+### 2.3	Matriz de Comunicação
+
+### 2.4	Gerenciamento de Riscos
+A análise e gerenciamento de riscos referem-se à identificação dos possíveis pontos que podem representar riscos para o projeto. Precisam ser acompanhados, a cada acompanhamento das fases, se referindo assim, ao projeto como um todo e não apenas ao produto.
+
+### 2.5	Critérios de Replanejamento
+Os critérios de replanejamento referem-se à identificação dos pontos que, caso ocorram, causarão um replanejamento do projeto. Precisam ser acompanhados a cada Ciclo, referindo-se assim, ao projeto como um todo e não apenas ao produto.
+
+
+## 3. PROCESSO DE DESENVOLVIMENTO DE SOFTWARE
+
+### 3.1 Metodologia de Desenvolvimento de Software
+Optamos pela metodologia de desenvolvimento agil SCRUM, pela facilidade, eficiência e colaboração com os stakeholders,  facilitando a resposta rápida para eventuais mudanças de requisitos e às prioridades dos usuários.
+
+### 3.2 Diagrama de Fluxo de Trabalho
+
+![Diagrama fluxo do trabalho](assets/diagrama.png)
+Figura x - Diagrama de Fluxo de Trabalho
+
+
+Nome da Atividade | Método | Ferramenta | Entrega |
+------------- | --------- | ------ | ----------
+Coleta de Requisitos | Entrevista com o cliente | Reunião Meet | Documento de requisitos funcionais  |
+Análise de Requisitos | Análise SWOT | Jira | Especificação de requisitos |
+Design | Prototipagem | Figma | Protótipo de alta fidelidade  |
+Implementação | Programação em pares | VsCode (ou alguma outra IDE), Git | Código fonte  |
+Testes | Manuais e automáticos | JUnit, PyTest | Relatórios de Testes  |
+CI/CD | Integração | Github | Pipeline CI/CD  |
+Usabilidade | Análise Heurística | Dashboard | Relatórios de usabilidade  |
+
+
+## 4. LIÇÕES APRENDIDAS
+### Unidade 1
+
+
+## 5. Referência Bibliográficas
+
+> 1. MARSICANO, George. Slides: Escolhas da Engenharia de Software. 2023. Disponível em: <https://aprender3.unb.br/pluginfile.php/2518488/mod_folder/content/0/Unidade%201%20-%20Aula%20-%20Escolhas%20da%20ESW.pdf>
+> 2. Raja Gupta. Fundamentals of Software Engineering. Engineering Handbook. 2019
+> 3. IEEE. SWEBOK. Version 3. 2014.
+> 4. Handbook IREB CPRE Foundation Level, Version 1.1.0, september 2022.
+> 5. MARSICANO, George. Slides: Introdução a Engenharia de Requisitos. 2023. Disponível em: <https://aprender3.unb.br/pluginfile.php/2518489/mod_folder/content/0/Unidade%201%20-%20Aula%20-%20Introducao%20a%20ER.pdf> 
+> 6. Software Engineering | Rapid application development model, 2023. Disponível em <https://www.geeksforgeeks.org/software-engineering-rapid-application-development-model-rad/> Acesso em 24 de maio de 2023.
+
+## 7. Historico de Versão
+
+Data | Versão | Descrição | Autor | Revisores
+---- | ------ | --------- | ----- | ---------
+17/04/24 | 0.1 | Criação do documento | Joyce | 
+17/04/24 | 0.2 | Atualização do documento | Joyce | 

docs/index.md

@@ -0,0 +1,50 @@
+# RISO - Reconhecimento Inteligente de Sorrissos
+
+## Equipe do Projeto
+<center>
+    <div style="display: flex; flex-direction: row; gap: 10px; flex-wrap: wrap; justify-content: center;">
+        <div>
+            <a href="https://github.com/LucasAvelar2711">
+                <img style="border-radius: 50%;" src="https://github.com/LucasAvelar2711.png" width="80px"/>
+                <h6 class="text-center">Lucas Antunes de Avelar</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/joycejdm">
+                <img style="border-radius: 50%;" src="https://github.com/joycejdm.png" width="80px"/>
+                <h6 class="text-center">JOYCE DIONIZIO DE MESQUITA</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/MarcoTulioSoares">
+                <img style="border-radius: 50%;" src="https://github.com/MarcoTulioSoares.png" width="80px"/>
+                <h6 class="text-center">Marco Tulio Soares</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/JoosPerro">
+                <img style="border-radius: 50%;" src="https://github.com/JoosPerro.png" width="80px"/>
+                <h6 class="text-center">JOAO PEDRO VERAS GOMES</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/joaopb1-xps">
+                <img style="border-radius: 50%;" src="https://github.com/joaopb1.png" width="80px"/>
+                <h6 class="text-center">JOAO PAULO BARROS DE CRISTO</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/xGabrielCv/xGabrielCv">
+                <img style="border-radius: 50%;" src="https://github.com/xGabrielCv.png" width="80px"/>
+                <h6 class="text-center">JESUS GABRIEL CARVALHO VENTURA</h6>
+            </a>
+        </div>
+        <div>
+            <a href="https://github.com/DanielRogs">
+                <img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/90018065?v=4" width="80px"/>
+                <h6 class="text-center">DANIEL RODRIGUES DA ROCHA</h6>
+            </a>
+        </div>
+    </div>
+</center>
+

docs/processoER/metodologia.md

@@ -0,0 +1 @@
+## Isto é um teste