DOCUMENTAÇÃO/WIKI/README (Revisão)

maiconandsilva-archive / dvd-store-website

Very simple website with two databases. One database for storing everything the website needs, the other for storing encrypted customer personal data. Encrypted keys are stored on Azure Secret Vault.

Academic Free License v3.0

4 stars 5 forks source link

DOCUMENTAÇÃO/WIKI/README (Revisão) #5

Closed maiconandsilva closed 3 years ago

maiconandsilva commented 3 years ago

Na documentação do projeto deve conter:

[x] Sumário (similar ao print que eu mandei abaixo)
[x] Problema (que o projeto se proprõe a solucionar)
[x] Solução (descricao das soluções encontradas para o problema)
[x] Adicionar explicação ao Burndown velocity chart (como são divididas as reuniões etc)
[x] Arquitetura do sistema
[x] GIFs e prints das telas do site
[x] Link para a demonstração do projeto no Heroku
[x] Rotas do site e métodos HTTP usados
[x] Explicação criptografia
[x] sprints já feitas em forma de checklist (com explicação do valor principal da entrega)
[x] Link para as sprints (milestones do github)
[x] Tecnologias usadas
[x] Instalação e execução
[x] Configuração de desenvolvimento
[x] Configuração dos serviços de banco de dados
[x] Integrantes do projeto

Links úteis:

WIKI
README

maiconandsilva commented 3 years ago

@Andrerodrigues0018, aceitar solicitação to Github para eu atribuir essa tarefa para você.

Você pode listar todas as tarefas que serão realizadas por aqui. Depois pode criar um issue para cada tarefa e atribuir para uma pessoa.

maiconandsilva commented 3 years ago

Achei legal da forma que eles fizeram

Integrantes do grupo - exemplo Sumário - exemplo

maiconandsilva commented 3 years ago

Algumas Informações do projeto

Principais bibliotecas Python:

cryptography==3.2.1 Flask==1.1.2 Flask-SQLAlchemy==2.4.4 Flask-WTF==0.14.3 Jinja2==2.11.2 SQLAlchemy==1.3.19 SQLAlchemy-Utils==0.36.8 WTForms-Alchemy==0.17.0

Framework CSS: UIkit 3.5.9

Pseudonimização do cliente/usuário:

Biblioteca Python usada para criptografia: cryptography
Algoritmo de criptografia simétrica usado: Fernet (link da especificação);
Para cada usuário é gerada uma chave aleatória de 256 bits que é guardada externamente junto ao id do usuário;
Se possível, colocar explicação resumida no documento.

Scripts SQL carregados pelo Docker: dellstore.sql e customer_personal_info.sql

maurosakugawa commented 3 years ago

@maiconandsilva e @Andrerodrigues0018, quanto ao sumário, será que não seria melhor algo do tipo 'table of contents', como no exemplo abaixo? Table-of-contents É assim que faço em meus repositórios, mas esse readme foi gerado pelo React-js. O Repositório onde está o readme é esse: https://github.com/maurosakugawa/Api-React-HTTP-fetch