Merge pull request #54 from fga-eps-mds/feature/17-criar-perfil-open-…

…source Criar perfil open source
fga-eps-mds · Sep 21, 2019 · 410c2cc · 410c2cc
2 parents d827499 + 4ccdfab
commit 410c2cc
Show file tree

Hide file tree

Showing 28 changed files with 828 additions and 756 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,49 @@
+# Código de Conduta
+
+## Propósito
+O projeto é mantido por estudantes durante a execução das disciplinas
+de Engenharia de Produto de Software e Métodos de Desenvolvimento de Software
+da Universidade de Brasília.
+Sendo assim, frisamos a importância de promover um ambiente aberto e acolhedor,
+nós mantenedores e contribuidores nos comprometemos a fazer participação em nosso
+projeto e nossa comunidade provendo uma experiência livre de assédio para todos.
+
+
+## Nossas Responsabilidades
+Os mantenedores desse projeto são responsáveis por prestar esclarecimentos em
+casos de dúvidas relacionadas ao código de conduta e também por ações em resposta
+a comportamentos inadequados.
+No caso de testemunhar comportamentos inadequados,
+estes devem ser reportados imediatamente, sendo os responsáveis do repositório
+obrigados a manter confidencialidade sobre a pessoa que reportar.
+
+## Exemplos de comportamentos esperados e que contribuem com o projeto
+
+* Uso de linguagem acolhedora e inclusiva
+* Respeito aos diferentes pontos de vista
+* Aceitar críticas construtivas
+* Demonstrar empatia com os membros da comunidade
+
+## Exemplos de comportamentos inaceitáveis
+
+* Uso de conotações sexuais
+* Comentários depreciativos que ataquem pessoas ou grupos
+* Assédio público ou privado
+* Publicação de conteúdo privado de terceiro sem prévia autorização
+* Outras condutas consideradas inapropriadas em um ambiente profissional
+
+
+## Escopo
+
+Esse Código de Conduta é aplicado dentro do projeto e em locais públicos onde
+um indivíduo esteja representando o projeto ou sua comunidade. Exemplos
+são um e-mail oficial sobre o projeto, ou participação em eventos como representante.
+
+
+## Atribuição
+
+Esse código de conduta é uma adaptação de [Contributor Covenant][homepage], version 1.4,
+disponível em [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# Como contribuir
+
+Antes de enviar uma alteração para este repositório,
+coloque-se como responsável por ela via issues do github. Verifique se você
+está seguindo nossa política de branches e commits e se sua branch segue a checklist de
+pull request:
+* Os commits seguem o padrão de estilo desse projeto.
+* A branch está conforme nossa política.
+* Houve sucesso na integração continua.
+* Os critérios de aceitação foram cumpridos.
+* Foram realizados testes (sendo o caso) que cobrem as funcionalidades entregues.
+
+
+Este repositório possui um código de conduta que deverá ser seguido em todas as
+interações com ele.
+
+## Processo de criação de issues
+
+1. Verifique se não existe issue que já adereça o que você pretender colocar.
+2. Ao criar a issue, espere a resposta de uns dos responsáveis pelo repositório
+para sua aprovação.
+
+## Processo de Pull Request
+
+1. Execute em sua máquina os testes que existiam antes da sua alteração, e apenas
+envie o Pull Request caso ainda estejam passando.
+2. Espere o processo da integração continua, como uma segunda verificação.
+3. Ao criar o Pull Request, siga o template disponível em docs/pull_request_template.md
+4. Selecione um desenvolvedor do projeto para revisar o seu Pull Request, além disso ele
+será revisado pelo scrum master,apenas
+então ele poderá ser aceito.
+
+
+
+Obrigada por querer contribuir com o projeto <3!
diff --git a/docs/README.md b/docs/README.md
@@ -1 +1,69 @@
-# 2019.2-TimeBolinho
+<p align="center">  <img src="img/wordmark_1.svg" width="400"></p>
+
+## Visão geral
+
+Acácia propõe-se a facilitar a criação de uma comunidade voluntária em torno da agricultura urbana, diminuindo o desperdício de comida e difundindo conhecimento em plantio e colheita neste ambiente. Para tal, a ferramenta conecta pessoas que possuem plantas frutíferas em local urbano, voluntários de colheita e beneficiários que buscam doações de alimentos, para que estes possam trabalhar juntos, com colheita colaborativa.
+
+Este repositório tem como objetivo o desenvolvimento, a manutenção e a evolução do produto nomeado **Acácia**, uma aplicação web, que segue o conceito [Mobile first](https://digitalks.com.br/artigos/mobile-first-e-o-que-voce-realmente-precisa-saber-respeito/) e tem o intuito de auxiliar no processo de colheita colaborativa em áreas urbanas. Ele é baseado em um sistema já existente, o [Saskatoon](https://github.com/tiagovaz/saskatoon) utilizado pelo coletivo [LES FRUITS DÉFENDUS](https://santropolroulant.org/en/what-is-the-roulant/collectives/fruits-defendus/) em Montreal - que facilita a relação entre proprietários de árvores frutíferas, voluntários para colheita e beneficiários das doações dessas frutas, visando a redução do desperdício de comida.
+
+
+
+## Como contribuir
+
+
+
+Para contribuir com este projeto basta seguir:
+
+-  [Guia de Contribuição](https://fga-eps-mds.github.io/2019.2-Acacia/#/contributing) 
+
+-  [Código de Conduta](https://fga-eps-mds.github.io/2019.2-Acacia/#/code-of-conduct)
+
+-  [Guia de Instalação](#guia-de-instalação)
+
+-  [Políticas de Contribuição](https://fga-eps-mds.github.io/2019.2-Acacia/#/policies)
+
+-  [Template para criação de issues](https://github.com/fga-eps-mds/2019.2-Acacia/tree/develop/.github/ISSUE_TEMPLATE)
+
+-  [Template para criação de pull requests](https://github.com/fga-eps-mds/2019.2-Acacia/blob/develop/.github/PULL_REQUEST_TEMPLATE.md)
+
+
+
+## Guia de Instalação
+
+
+
+Essa aplicação tem seu ambiente configurado através de conteiners [Docker](https://www.docker.com), portanto, tem como pré-requisitos a instalação do [Docker](https://www.docker.com/get-started) e [Docker-compose](https://docs.docker.com/compose/install/).
+
+Também é necessário ter o [Git](https://git-scm.com) instalado para clonar o repositório.
+
+
+
+#### Back-end:
+
+Clonar o repositório:
+
+
+
+`git clone https://github.com/fga-eps-mds/2019.2-Acacia.git`
+
+
+
+Execução do conteiner:
+
+
+
+`docker-compose up`
+
+
+
+Após esses passos a aplicação deverá estar acessível em:
+
+
+
+`localhost:8080`
+
+
+
+#### Front-end:
+
+Para instalar a camada front-end da aplicação basta seguir os passos de instalação descritos [aqui](https://github.com/fga-eps-mds/2019.2-Acacia-Frontend)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
diff --git a/docs/architecture-project.md b/docs/architecture-project.md
diff --git a/docs/img/EAP.png b/docs/img/EAP.png
diff --git a/docs/img/LowFidelityPrototype.png b/docs/img/LowFidelityPrototype.png
diff --git a/docs/img/LowFidelityPrototypeScreens_1.png b/docs/img/LowFidelityPrototypeScreens_1.png
diff --git a/docs/img/LowFidelityPrototypeScreens_2.png b/docs/img/LowFidelityPrototypeScreens_2.png
diff --git a/docs/img/logo.svg b/docs/img/logo.svg
diff --git a/docs/img/monocromatica_1.svg b/docs/img/monocromatica_1.svg
diff --git a/docs/img/monocromatica_2.svg b/docs/img/monocromatica_2.svg
diff --git a/docs/img/svg_monocromática_black_background.svg b/docs/img/svg_monocromática_black_background.svg
diff --git a/docs/img/svg_monocromática_blue_background.svg b/docs/img/svg_monocromática_blue_background.svg
diff --git a/docs/img/svg_monocromática_white_background.svg b/docs/img/svg_monocromática_white_background.svg