Added documentation for hollow website

elyasha · elyasha · commit 65dce119ea46 · 2020-09-13T14:07:42.000+02:00
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@
  
 1. Clone the repo
 ```sh
-git clone git@github.com:CodeAndCoffee55/hollow-docs.git
+git clone git@github.com:Coding55/hollow-docs.git
 ```
 2. Follow the instruction in mkdocs.md
 ```sh
diff --git a/docs/about/about.md b/docs/about/about.md
@@ -0,0 +1,9 @@
+# Versões utilizadas
+Para o projeto do website da Hollow utilizamos Python/Django para o código e PostgreSQL para a base de dados.
+
+
+1. `Django 3.0.10`
+2. `Python 3.8.5`
+3. `PostgreSQL 12`
+
+Para mais informações, ver `requirements.txt`.
diff --git a/docs/about/contributing.md b/docs/about/contributing.md
@@ -0,0 +1,11 @@
+## Contribuição
+
+São as contribuições que fazem da comunidade de código aberto um lugar tão extraordinário para aprender, inspirar e criar. Todas as contribuições que são feitas serão **muito apreciadas**.
+
+- Fork do projeto (```fork```)
+- Crie sua branch "Feature" (```git checkout -b feature/AmazingFeature```)
+- Realize suas modificações (```git commit -m 'Add some AmazingFeature'```)
+- Push da sua branch Branch (```git push origin feature/AmazingFeature```)
+- Criar um pull request (```PR```)
+
+Obrigado antecipadamente pela sua ajuda ;)
diff --git a/docs/admin/admin.md b/docs/admin/admin.md
@@ -0,0 +1,8 @@
+# Site de administração do Django
+
+Uma das partes mais poderosas do Django é a interface de administração automática. Lê os metadados dos seus modelos para fornecer uma interface rápida e centrada em modelos, onde os utilizadores de confiança podem gerir o conteúdo do site. O uso recomendado do site de administração é limitado a uma ferramenta de gestão interna de uma organização. Não se destina a ser utilizado como base para a construção de uma interface pública completa.
+
+O site de administração tem muitos pontos de entrada para personalização, mas não se limite a utilizar exclusivamente estes pontos de entrada. Se precisar de fornecer uma interface mais centrada no processo que ignore os detalhes de implementação em torno de tabelas e campos de base de dados, este é provavelmente o momento de escrever as suas próprias opiniões.
+
+# Para mais informações:
+[Documentação para admin](https://docs.djangoproject.com/en/3.0/ref/contrib/admin/)
diff --git a/docs/admin/how-to-use.md b/docs/admin/how-to-use.md
@@ -0,0 +1,12 @@
+# Como utilizar o site do administrador (admin)
+
+Para utilizar o site, basta ir a ``/{ADMIN_URL}``, que pode ser um valor diferente para segurança do website.
+
+# Vai ter uma interface gráfica
+
+![Página admin](../img/admin/page.PNG)
+
+Na interface, existe a possibilidade de alterar os dados na base de dados de uma forma muito mais simples.
+
+Convidamo-lo a jogar com a página, é realmente simples e esperamos que goste de modificar as suas páginas.
+
diff --git a/docs/admin/role.md b/docs/admin/role.md
@@ -0,0 +1,36 @@
+# Papel de um administrador do servidor
+
+As atribuições clássicas do administrador são as seguintes:
+
+instalar e desinstalar ;
+
+configuração;
+
+manutenção;
+
+actualização;
+
+evolução;
+
+apoio;
+
+restauração;
+
+planejamento;
+
+supervisão;
+
+aconselhamento;
+
+apoio;
+
+vigilância tecnológica no perímetro técnico de hardware e software do tipo servidor, principalmente sistemas operativos.
+
+Por vezes tem a tarefa de administração de redes e/ou administração de bases de dados em pequenas organizações.
+
+# Habilidades
+Os administradores de sistemas não são arquitectos ou programadores de software. Em geral, não lhes são atribuídas tarefas de concepção e implementação de novas aplicações. No entanto, devem compreender como o software se comporta para o implementar e resolver vários problemas que o afectam. O conhecimento de diferentes linguagens de escrita e automatização de rotina (tais como PowerShell, Bash e Perl ou Python) é muitas vezes necessário.
+
+# Para mais informações
+
+[Wikipedia - Administrador de Sistemas](https://en.wikipedia.org/wiki/System_administrator)
diff --git a/docs/contact/contact-us.md b/docs/contact/contact-us.md
@@ -0,0 +1,6 @@
+### Em caso de qualquer problema, não hesite em contactar-nos:
+
+Matheus Elyasha LOPES : matheus.elyasha@coding55.com
+
+
+Eduardo Matheus BORGES : eduardo.borges@coding55.com
diff --git a/docs/database/database.md b/docs/database/database.md
@@ -0,0 +1,109 @@
+
+# Base de dados
+
+O objectivo deste arquivo é explicar as principais relações da base de dados; a base de dados principal, as suas tabelas, a forma como os dados são armazenados e dar uma imagem global da nossa base de dados.
+
+A aplicação do website da Hollow contém diferentes modelos, que são implementadas em arquivos do tipo `models.py`.
+
+Se quiser criar um novo modelo, terá de o fazer neste arquivo.
+
+Para mais informações sobre bases de dados Django, consulte por favor a [`documentação`](https://docs.djangoproject.com/en/3.0/topics/db/models/) 
+
+## Especificações
+
+Serviço: heroku-postgresql
+
+- PLANO : [standard-0](https://devcenter.heroku.com/articles/heroku-postgres-plans)
+- Aplicação de facturação: 
+
+- Região: 
+- Primário: 
+- Versão : 
+- Criação : 
+- Cópias de segurança: 
+- Tabelas: 
+- Usando : 
+
+## Comandos com Heroku ##
+
+Utilize o [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command-line) para aceder aos registos a partir da linha de comando.
+```bash 
+heroku logs --tail --ps postgres --app {app_name}
+```
+
+Para se ligar à base de dados (OBS: É melhor utilizar o DataGrip)
+```bash 
+heroku psql --app {app_name}
+```
+
+Para recuperar as referências do banco
+```bash
+heroku pg:credentials:url --app {app_name}
+```
+
+Ajuda para exibir informação de base de dados
+```bash
+heroku pg --app {app_name} --help
+```
+
+Para mais informações
+```bash
+heroku help
+```
+
+## Ficha técnica
+
+Os `dataclips` são essencialmente consultas SQL que podem ser partilhadas com os colegas através de Heroku.
+Se tiver uma query em SQL que gostaria de partilhar com a equipa, sinta-se à vontade para a acrescentar [aqui](https://data.heroku.com/dataclips).
+
+
+- Para mais informações, por favor visite [documentação](https://devcenter.heroku.com/articles/dataclips)
+
+## Tabelas
+Para visualizar as tabelas e as suas relações, podemos utilizar o DataGrip e exportá-las em formato pdf. 
+
+Para encontrar o diagrama de relações, basta ir à pasta "tabelas", clicar com o botão direito do mouse e seleccionar "Diagramas" e "Ver Vista", ou usar o atalho "Ctrl+Alt+Shift+U".
+
+
+## Relacionamentos
+Na teoria das bases de dados relacionais, existem 3 tipos principais de relações:
+
+1. Um-para-um (um-para-um):
+Uma linha num campo da tabela está relacionada apenas com um outro elemento da tabela.
+Por exemplo, temos as relações "membro" e "utilizador". O membro e o utilizador devem ser a mesma pessoa. Representam então um único elemento.
+
+2. "Um a muitos (1 - n)": um elemento de um campo numa tabela pode ser ligado a vários outros elementos de outra tabela.
+Por exemplo, temos relações de "cidade" e "país". Uma cidade pode ter apenas um país, mas um país pode ter várias cidades.
+
+3. "Muitos para muitos (n - n)": a relação de pluralidade é para trás e para a frente. Por exemplo, "utilizador" e "evento". 
+Um utilizador pode ter vários eventos e um evento pode ter vários utilizadores.
+
+## Como armazenar dados
+
+O armazenamento de dados é muito importante. Temos de considerar os seguintes aspectos 
+acrescentando dados à base de dados BRASA:
+
+1) ``Dados actuais``: processar sempre dados actuais.
+2) `Integridade dos dados`: os dados devem ser completos, não corrompidos ou incompletos.
+3) `Limpeza de dados`: os dados devem estar limpos, nenhuma informação deve ser acrescentada a nada.
+4) ``Padronização dos dados``: Os dados devem ser padronizados. A mesma coluna da base de dados não deve ser utilizada.
+para dados que pertencem a dois tipos diferentes de formatação.
+5) `Consistência dos dados`: os dados devem ser coerentes. Do ponto de vista da homogeneidade, consistência e firmeza. 
+Não se deve trabalhar com dados que estejam ou venham a estar quebrados no futuro.
+
+Use o comando :
+```
+Command:     INSERT
+Description: create new rows in a table
+Syntax:
+[ WITH [ RECURSIVE ] with_query [, ...] ]
+INSERT INTO table_name [ AS alias ] [ ( column_name [, ...] ) ]
+```
+
+Para mais informações :
+
+- Vídeo SQL : [CS50 SQL](https://www.youtube.com/watch?v=u5pDdEKnbKA)
+
+- Folha de dados SQL e outras informações : [w3schools SQL](https://www.w3schools.com/sql/sql_ref_keywords.asp) 
+
+
diff --git a/docs/database/postgres.md b/docs/database/postgres.md
@@ -0,0 +1,58 @@
+# PostgreSQL
+PostgreSQL™ é um sistema de gestão de bases de dados relacionais orientadas para objectos (ORDBMS) baseado no POSTGRES, Versão 4.2™. Foi desenvolvido na Universidade da Califórnia, no Departamento de Informática de Berkeley. POSTGRES é a origem de muitos conceitos que só serão disponibilizados em sistemas de gestão de bases de dados comerciais muito mais tarde.
+
+PostgreSQL™ é um descendente livre do código original de Berkeley. Suporta grande parte da norma SQL, ao mesmo tempo que oferece muitas características modernas:
+
+consultas complexas;
+
+chaves estrangeiras;
+
+gatilhos;
+
+vistas editáveis;
+
+integridade transaccional;
+
+Controlo de Concorrência MultiVersion (MVCC).
+
+Além disso, PostgreSQL™ pode ser alargado pelo utilizador de múltiplas formas, por exemplo, acrescentando :
+
+novos tipos de dados;
+
+novas funções;
+
+novos operadores;
+
+novas funções de agregação;
+
+novos métodos de indexação;
+
+novas línguas processuais.
+
+E graças à sua licença liberal, PostgreSQL™ pode ser utilizado, modificado e distribuído livremente para qualquer fim, seja privado, comercial ou académico.
+
+# Instalação
+Para instalar, basta ir a [o link para download](https://www.postgresql.org/download/) e escolher a versão correcta
+para o seu sistema operativo. Tenha cuidado com a instalação porque por vezes o instalador pode pedir para instalar outras coisas.
+
+## Executando o servidor como localhost (127.0.0.1)
+Uma vez instalado, pode ir divertir-se com o postgreSQL. Basta utilizar o `pgAdmin 4`. Na verdade, não é necessário 
+procure no seu sistema por um programa chamado "Postgres". Pode utilizar a interface gráfica ``pgAdmin```, 
+ou utilizar directamente na "linha de comando" com "psql".
+
+
+## Tutorial PostgreSQL
+Se quiser aprender a utilizar o software e achar que é uma boa ideia ter os seus conhecimentos. 
+Aviso: é especialmente importante que o administrador do sítio tenha bons conhecimentos para gerir a base de dados.
+
+[Tutorial postgres](https://docs.postgresql.fr/10/tutorial.html)
+
+
+## Para mais informações, ver a documentação
+[Documentação (Inglês)](https://www.postgresql.org/docs/)
+
+[Documentação actual (francês)](https://docs.postgresql.fr/)
+
+[PostgreSQL 10 Documentação (francês)](https://docs.postgresql.fr/10)
+
+
diff --git a/docs/database/queries.md b/docs/database/queries.md
@@ -0,0 +1,15 @@
+# SQL: ``Linguagem de Consulta Estruturada`` ou ``Linguagem de Consulta Estruturada``.
+
+SQL é uma linguagem informática padronizada para operar bases de dados relacionais.
+De fato, no nosso projeto, não precisamos necessariamente utilizar SQL, uma vez que Django, já é capaz de
+devidamente escrever SQL na nossa base de dados. Por outro lado, se alguma vez precisar de fazer um estudo mais robusto, precisa de pensar se SQL não ser'a a resposta correcta.
+
+[Cursos e tutoriais em linguagem SQL](https://sql.sh/)
+
+[Wikipedia - SQL](https://fr.wikipedia.org/wiki/Structured_Query_Language)
+
+[Tutorial SQL com PostgreSQL](https://docs.postgresql.fr/10/tutorial-sql.html)
+
+[Vídeo CS50 SQL](https://www.youtube.com/watch?v=u5pDdEKnbKA)
+
+[Cheatsheet and other info (w3schools SQL)](https://www.w3schools.com/sql/sql_ref_keywords.asp) 
diff --git a/docs/deployment/deploy.md b/docs/deployment/deploy.md
@@ -1,5 +1,5 @@
-# Implantação
-A implantação do site da **Hollow** e todas as atividades que tornam o serviço web disponível para uso.
+# Deploy
+O deploy do site da **Hollow** e todas as atividades que tornam o serviço web disponível para uso.
 
 As fases da atividade de implantação são:
 
diff --git a/docs/development/adding-feature.md b/docs/development/adding-feature.md
@@ -0,0 +1,8 @@
+### Para criar uma nova característica você deve :
+
+* Criar uma url correspondente à página dedicada a seu recurso em algum arquivo [urls.py`](https://docs.djangoproject.com/en/3.0/topics/http/urls/).
+* Crie o arquivo html correspondente à sua nova página no diretório [`templates`](https://developer.mozilla.org/fr/docs/Web/HTML).
+* Crie as consultas relacionadas à sua nova página no arquivo [views.py`](https://docs.djangoproject.com/en/3.0/topics/http/views/).
+* Se sua característica requer um formulário, você deve criá-lo no arquivo [`forms.py`](https://docs.djangoproject.com/en/3.0/ref/forms/).
+* Para mudar a aparência de sua página você deve criar um arquivo css correspondente à sua página na pasta [static/css](https://developer.mozilla.org/fr/docs/Web/CSS/Reference).
+* Se você quiser adicionar imagens e fontes para sua página, isto será feito na pasta `media`.
diff --git a/docs/development/dev.md b/docs/development/dev.md
@@ -0,0 +1,16 @@
+# Branch `develop`
+
+No projeto Azure DevOps da aplicação, o branch em que o desenvolvimento será feito é a branch __dev__.
+
+Quando você quiser modificar o código da aplicação, você precisa :
+
+* Criar uma branch __nova__ (com um nome explícito, se possível, relacionado com as mudanças que serão feitas ali).
+
+* Uma vez feitas as mudanças neste novo branch, o `commit` deve ser formado com um título explícito e uma breve descrição do trabalho realizado na branch.
+
+* Depois é feito um pedido de __pull request__
+
+* Uma vez que todos os desenvolvedores tenham assegurado que não haja conflito entre o novo código e o código existente, podemos __fundir__ a nova branch na branch __dev__.
+
+
+***É fortemente recomendado não modificar diretamente a branch dev, caso contrário podem ser introduzidos erros no código, cuja origem não pode ser conhecida a priori.
diff --git a/docs/development/run-project-locally.md b/docs/development/run-project-locally.md
@@ -0,0 +1,28 @@
+Fazer o clone do repositório na sua maquina local : 
+```bash
+$ git clone https://coding55@dev.azure.com/coding55/hollow-website/_git/hollow-website
+```
+
+Migrar o banco de dados : 
+
+```bash
+$ python manage.py makemigrations 
+
+$ python manage.py migrate --noinput
+```
+
+Iniciar um servidor Django : 
+
+```bash
+$ python manage.py runserver
+```
+
+Agora você deve ter a sua aplicação em [localhost](http://127.0.0.1:8000) no seu navegador. 
+
+
+Quando quiser sair, não se esqueça de fechar o servidor : 
+
+```bash
+Quit the server with CTRL-BREAK
+(In Windows) Ctrl + C
+```
diff --git a/docs/development/testing.md b/docs/development/testing.md
@@ -0,0 +1,5 @@
+Antes de implantar a aplicação do website da Hollow, é necessário realizar vários testes para garantir que a aplicação funcione corretamente.
+
+Já codificamos alguns testes básicos antes de lançar nossa versão da aplicação, mas caso novas funcionalidades sejam adicionadas à aplicação básica, seria aconselhável escrever novos testes dedicados a esta funcionalidade nos arquivos `tests.py`.
+
+Para mais informações sobre os testes, favor consultar [a documentação dedicada](https://docs.djangoproject.com/fr/3.0/internals/contributing/writing-code/unit-tests/)
diff --git a/docs/django/django.md b/docs/django/django.md
@@ -0,0 +1,23 @@
+### Princípio Django
+
+Django é uma estrutura baseada no princípio MVC ou MTV, composta de três partes distintas:
+
+1. Uma linguagem flexível de modelos que permite gerar HTML, XML ou qualquer outro formato de texto ;
+2. Um controlador fornecido sob a forma de um URL "remapping" baseado em expressões regulares ;
+3. Uma API de acesso aos dados é gerada automaticamente pela estrutura compatível com CRUD. Não há necessidade de escrever consultas SQL associadas aos formulários, elas são geradas automaticamente pelo ORM.
+
+Além da API de acesso aos dados, uma interface de administração funcional é gerada a partir do modelo de dados. Um sistema de validação dos dados inseridos pelo usuário também está disponível e permite que mensagens de erro automáticas sejam exibidas.
+
+Também estão incluídos :
+
+* um servidor web leve que permite desenvolver e testar suas aplicações em tempo real, sem necessidade de implantação ;
+
+* um elaborado sistema de processamento de formulários com widgets para interagir entre HTML e um banco de dados. São oferecidas inúmeras possibilidades de controle e processamento;
+
+* uma estrutura de caching web que pode utilizar diferentes métodos (MemCached, sistema de arquivo, banco de dados, personalizado);
+
+* suporte para classes intermediárias (middleware) que podem ser colocadas em vários estágios de processamento de consultas para integrar tratamentos particulares (caching, internacionalização, acesso...);
+
+* suporte completo Unicode.
+
+Para mais informações, consulte [a documentação Django](https://docs.djangoproject.com/en/3.0/)
diff --git a/docs/django/python.md b/docs/django/python.md
@@ -0,0 +1,5 @@
+A estrutura Django usa Python como linguagem de programação.
+
+Para codificar a aplicação do website Hollow utilizamos [`Python 3.8.5`](https://www.python.org/downloads/release/python-385/)
+
+Para mais informações, consulte [a documentação Python](https://www.python.org/doc/)
diff --git a/docs/heroku/static-files.md b/docs/heroku/static-files.md
@@ -13,6 +13,6 @@ Para mais informações:
 
 [Amazon S3](https://aws.amazon.com/s3/)
 
-[Prix - Amazon S3](https://aws.amazon.com/s3/pricing/)
+[Preço - Amazon S3](https://aws.amazon.com/s3/pricing/)
 
 [Amazon AWS](https://aws.amazon.com/)
diff --git a/docs/img/admin/page.PNG b/docs/img/admin/page.PNG
diff --git a/docs/img/favicon-hollow.png b/docs/img/favicon-hollow.png
diff --git a/docs/img/logo_hollow.png b/docs/img/logo_hollow.png
diff --git a/docs/index.md b/docs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml

-Original file line number
+Diff line change
 . Clone the repo
 ```sh
 -git clone [email protected]:CodeAndCoffee55/hollow-docs.git
 +git clone [email protected]:Coding55/hollow-docs.git
 ```
 . Follow the instruction in mkdocs.md
 ```sh