diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..9fdbf849 --- /dev/null +++ b/404.html @@ -0,0 +1,772 @@ + + + +
+ + + + + + + + + + + + + + +O AcheiUnB é um sistema de achados e perdidos voltado para estudantes da UnB. O objetivo é facilitar a localização e recuperação de itens perdidos, fornecendo uma plataforma web onde os usuários podem registrar e buscar itens que foram encontrados ou esquecidos. Este documento descreve a arquitetura do sistema, abordando os principais componentes e a interação entre eles.
+O sistema é dividido em três camadas principais:
+Cada uma dessas camadas possui subcomponentes específicos, conforme descrito a seguir.
+A camada de back-end é onde a lógica de negócio reside. Ela gerencia as requisições feitas pelo front-end e acessa o banco de dados para fornecer dados ou salvar novas informações. O back-end é dividido nos seguintes subcomponentes:
+Items: Gerencia o registro e as atualizações dos itens de achados e perdidos, incluindo detalhes sobre o item e o status.
+Django: O framework principal do sistema, responsável por gerenciar as requisições HTTP, lógica de autenticação e rotas de API. Django é utilizado para orquestrar as chamadas aos módulos da API e coordenar o acesso ao banco de dados.
+Celery: Ferramenta de execução de tarefas assíncronas que lida com processos em segundo plano, como envio de notificações aos usuários quando um item correspondente ao seu interesse é registrado no sistema.
+O sistema utiliza uma variedade de tecnologias para garantir escalabilidade, modularidade e facilidade de manutenção:
+CodeCov: Plataforma online de relatório de testagem de código, utilizada para gerar gráficos de acompanhamento e sugestão de melhoria na testagem de código do software. Funciona conectando o repositório à uma conta na plataforma e enviando os relatórios dos teste gerados pela pipeline CI/CD.
+Design/Front-end:
+Prettier: Ferramenta de formatação de código para garantir consistência no código front-end.
+Back-end:
+Interação do Usuário com o Front-end: O usuário acessa o Client (Web) para visualizar, registrar ou buscar itens perdidos. A interface foi projetada para ser intuitiva e fácil de navegar.
+Requisições para a API: O Client (Web) envia requisições para a API no back-end para realizar operações, como registro de itens, atualização de informações de usuário, ou busca de itens.
+Processamento de Lógica de Negócio no Back-end: A API processa a requisição e, se necessário, consulta ou salva informações no banco de dados. O Django gerencia essa comunicação, enquanto Celery executa tarefas assíncronas.
+Acesso ao Banco de Dados: O Django se conecta ao PostgreSQL para acessar ou armazenar dados. Todo o fluxo de dados entre a API e o banco de dados é gerenciado através do ORM do Django, o que facilita a manipulação de dados e mantém a integridade das transações.
+Execução de Tarefas Assíncronas: Em caso de tarefas que não precisam ser concluídas imediatamente (por exemplo, envio de notificações), Celery executa essas operações em segundo plano.
+A arquitetura do AcheiUnB foi desenvolvida para ser modular, escalável e de fácil manutenção, utilizando tecnologias amplamente adotadas no mercado. Com o uso do Django, PostgreSQL e Docker, o sistema é robusto o suficiente para suportar o volume de usuários esperado e flexível para evoluir conforme a necessidade dos usuários. A separação clara entre front-end, API e banco de dados permite um desenvolvimento colaborativo eficiente e facilita a futura expansão da plataforma.
+ + + + + + + + + + + + + +Este documento tem como objetivo direcionar e guiar os relacionamentos dentro da produção do projeto, abrangendo a colaboração entre os integrantes do squad/grupo, o contato dos nossos desenvolvedores com os outros grupos envolvidos na disciplina, a nossa comunicação com a professora Carla Rocha, que será nossa orientadora durante a realização do projeto, e, por último, a interação entre a criação do produto e seus usuários.
+Dessa forma, a partir deste código serão definidos princípios básicos que deverão nortear todo o seguimento do projeto, seja no dia a dia, seja em situações de conflito ou obstáculos que possam surgir nas relações interpessoais ou mesmo intrapessoais.
+Nós, como membros, colaboradores e líderes, nos comprometemos a fazer da participação em nossa comunidade uma experiência livre de assédio para todos, independentemente de idade, tamanho corporal, deficiência visível ou invisível, etnia, características sexuais, identidade e expressão de gênero, nível de experiência, educação, status socioeconômico, nacionalidade, aparência pessoal, raça, religião ou identidade e orientação sexual.
+Comprometemo-nos a agir e interagir de maneira que contribuam para uma comunidade aberta, acolhedora, diversa, inclusiva e saudável.
+Os líderes da comunidade são responsáveis por esclarecer e aplicar nossos padrões de comportamento aceitável e tomar ações corretivas apropriadas e justas em resposta a qualquer comportamento que considerem inadequado, ameaçador, ofensivo ou prejudicial.
+Os líderes da comunidade têm o direito e a responsabilidade de remover, editar ou rejeitar comentários, commits, código, edições de wiki, issues e outras contribuições que não estejam alinhadas a este Código de Conduta, e comunicarão os motivos das decisões de moderação quando apropriado.
+Este Código de Conduta se aplica a todos os espaços da comunidade e também se aplica quando um indivíduo estiver representando oficialmente a comunidade em espaços públicos. Exemplos de representação da nossa comunidade incluem o uso de um endereço de e-mail oficial, postagens em uma conta oficial de redes sociais ou atuação como representante designado em um evento online ou offline.
+Casos de comportamento abusivo, de assédio ou de outra forma inaceitável podem ser reportados aos líderes da comunidade responsáveis pela aplicação no e-mail acheiunb2024@gmail.com. Todas as queixas serão analisadas e investigadas de forma rápida e justa.
+Todos os líderes da comunidade têm a obrigação de respeitar a privacidade e a segurança do denunciante de qualquer incidente.
+Os líderes da comunidade seguirão estas Diretrizes de Impacto na Comunidade para determinar as consequências de qualquer ação que considerem uma violação deste Código de Conduta:
+Impacto na Comunidade: Uso de linguagem inadequada ou outro comportamento considerado não profissional ou indesejado na comunidade.
+Consequência: Um aviso privado, por escrito, dos líderes da comunidade, esclarecendo a natureza da violação e explicando por que o comportamento foi inadequado. Um pedido público de desculpas pode ser solicitado.
+Impacto na Comunidade: Uma violação por meio de um único incidente ou uma série de ações.
+Consequência: Uma advertência com consequências para comportamento contínuo. Nenhuma interação com as pessoas envolvidas, incluindo interação não solicitada com aqueles que aplicam o Código de Conduta, por um período específico de tempo. Isso inclui evitar interações em espaços da comunidade, bem como em canais externos como redes sociais. A violação desses termos pode levar a um banimento temporário ou permanente.
+Impacto na Comunidade: Uma violação séria dos padrões da comunidade, incluindo comportamento inadequado sustentado.
+Consequência: Um banimento temporário de qualquer tipo de interação ou comunicação pública com a comunidade por um período específico. Nenhuma interação pública ou privada com as pessoas envolvidas, incluindo interação não solicitada com aqueles que aplicam o Código de Conduta, é permitida durante esse período. A violação desses termos pode levar a um banimento permanente.
+Impacto na Comunidade: Demonstração de um padrão de violação dos padrões da comunidade, incluindo comportamento inadequado sustentado, assédio a um indivíduo ou agressão a grupos de pessoas.
+Consequência: Um banimento permanente de qualquer tipo de interação pública dentro da comunidade.
+Este Código de Conduta é adaptado do Contributor Covenant, versão 2.1, disponível em https://www.contributor-covenant.org/pt-br/version/2/1/code_of_conduct.html.
+This Code of Conduct is adapted from the Contributor Covenant, +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+Community Impact Guidelines were inspired by Mozilla's code of conduct +enforcement ladder.
+For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations.
+ + + + + + + + + + + + + +Obrigado por se interessar em contribuir para o projeto AcheiUnB! Este guia foi elaborado para ajudá-lo a colaborar de forma produtiva e consistente com nossa equipe.
+Sugira uma possível solução (opcional).
+Sugerir melhorias
+ Quer melhorar o projeto? Crie uma issue com a tag enhancement
e descreva:
Qualquer detalhe adicional que ajude na implementação.
+Implementar uma funcionalidade
+main
apenas para código testado e funcional.tipo/nome-da-contribuicao
+ Exemplos:feat/login-microsoft
fix/ajuste-autenticacao
docs/atualizacao-readme
<tipo>(escopo): mensagem
+ Exemplos:feat(auth): implementar autenticação Microsoft
fix(api): corrigir erro no endpoint de listagem
docs(readme): atualizar instruções de execução
main
antes de enviar o PR.``` + ## Descrição do Pull Request + +
+## O que foi feito? + - [ ] Implementação de ... + - [ ] Correção de ...
+## Checklist + - [ ] Meu código segue as diretrizes do projeto. + - [ ] Testei minha funcionalidade e ela está funcionando conforme esperado. + - [ ] Atualizei a documentação, se necessário. + ```
+bash
+ make test
Este projeto segue o Código de Conduta do Contributor Covenant. Seja respeitoso, inclusivo e ajude a manter um ambiente saudável para todos.
+Se tiver dúvidas ou precisar de ajuda, entre em contato conosco pelo e-mail oficial do projeto: +- acheiunb2024@gmail.com
+ + + + + + + + + + + + + +Caso identifique qualquer vulnerabilidade no sistema AcheiUnB, por favor, entre em contato imediatamente através do e-mail acheiunb2024@gmail.com. Nos comprometemos a responder e tratar quaisquer problemas de segurança com a maior agilidade possível.
+Após o recebimento do relatório, nossa equipe de segurança investigará a vulnerabilidade para confirmar sua autenticidade.
+Comunicação com o Relator:
+Manteremos contato contínuo com o relator para fornecer atualizações sobre o progresso da investigação e resolução.
+Resolução da Vulnerabilidade:
+Assim que a vulnerabilidade for confirmada, trabalharemos para corrigir o problema de forma rápida e eficaz. Nos esforçaremos para implementar uma atualização de segurança em um prazo razoável.
+Divulgação Responsável:
+Agradecemos a sua contribuição para manter a segurança do AcheiUnB. Juntos, podemos garantir uma plataforma mais segura e confiável para todos os usuários.
+Contato: Para quaisquer dúvidas ou preocupações sobre esta política de segurança, entre em contato conosco pelo e-mail acheiunb2024@gmail.com.
+Atualizado em novembro de 2024
+ + + + + + + + + + + + + +Ambos foram feitos em um quadro branco virtual compartilhado do Miro. Que pode ser acessado por este link
+Ou nesta apresentação:
+ + ++ + + + + + + + + + + + + +