Merge branch 'master' of https://github.com/mikaelhadler/valorize-vidas

mikaelhadler · mikaelhadler · commit 6793e3d41a3a · 2018-11-26T12:47:08.000-02:00
diff --git a/README.md b/README.md
@@ -1,31 +1,92 @@
-# valorize-vidas
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)
+
+
+# Valorize Vidas
+
+Este é um projeto para reescrever os sistemas atuais de prevenção ao suicídio da CVV.
+
+## Como começar
+
+Abaixo estão as instruções de como utilizar o projeto em ambiente de desenvolvimento e produção.
+
+### Pré Requisitos
+
+O que é necessário para rodar o projeto ?
 
-## Project setup
 ```
-npm install
+Node.Js 8.x
 ```
 
-### Compiles and hot-reloads for development
+### Instalando
+
+Para rodar o projeto em ambiente de desenvolvimento, basta executarr os passos abaixo
+
+Faça a instalação das dependências
+
 ```
-npm run serve
+npm run install
 ```
 
-### Compiles and minifies for production
+Faça a execução do projeto:
+
 ```
-npm run build
+npm run serve
 ```
 
-### Lints and fixes files
+Feito isso, você poderá acessar a aplicação no endereço 'localhost:8080'.
+
+## Rodando os testes
+
+Para rodar os testes unitários, basta executarr o comando abaixo:
+
 ```
-npm run lint
+npm run test:unit
 ```
 
-### Run your unit tests
+### Rodando os testes de integração
+
+Para rodar os testes e2e, basta executar o comndo abaixo:
+
 ```
-npm run test:unit
+npm run test:e2e
 ```
 
-### Run your end-to-end tests
+### Rodando o eslint
+
+Para rodar o eslint, basta executar o comndo abaixo:
+
 ```
 npm run test:e2e
 ```
+
+### Style Guide
+
+Neste projeto, utilizamos o style guide baseado no [airbnb](https://github.com/airbnb/javascript).
+
+
+### Para compilar e minificar arquivos para produção 
+```
+npm run build
+```
+
+## Contruído com 
+
+* [Bulma](https://bulma.io/) - Framework de UI components
+* [Vue](https://vuejs.org/) - Framework de renderização
+* [Sass](https://rometools.github.io/rome/) - Framework de estilos
+
+## Contribuição
+
+Por favor leia o [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) para mais detalhe do processo de produção, dúvidas ou sugestões, enviar via pull request.
+
+## Versionamento
+
+Nós utilizamos o [GitFlow](https://medium.com/trainingcenter/utilizando-o-fluxo-git-flow-e63d5e0d5e04) para o versionamento. Para utilizar versões anteriores veja as [tags neste repositorio](https://github.com/valorizevidas/valorize-vidas/tags). 
+
+## Contribuidores
+
+
+## Licensa
+
+Este projeto utiliza a licença MIT - olhe no arquivo [LICENSE.md](LICENSE.md) para mais detalhes.
+
diff --git a/package.json b/package.json
@@ -1,14 +1,27 @@
 {
   "name": "valorize-vidas",
   "version": "0.1.0",
-  "private": true,
+  "author": "ValorizeVidas",
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",
     "lint": "vue-cli-service lint",
     "test:unit": "vue-cli-service test:unit",
     "test:e2e": "vue-cli-service test:e2e"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ValorizeVidas/valorize-vidas.git"
+  },  
+  "homepage": "https://github.com/ValorizeVidas/valorize-vidas#readme",  
+  "keywords": [
+    "social",
+    "suicide",
+    "depression",
+    "help",
+    "opensource",
+    "health"
+  ],
   "dependencies": {
     "vue": "^2.5.17",
     "vue-router": "^3.0.1"
