Como Contribuir - Software-Design-2017/SSMais GitHub Wiki
Histórico de Revisão
| Data | Versão | Descrição | Autor(es) |
|---|---|---|---|
| 26/11/2017 | 1.0 | Abertura do Documento | João Paulo |
| 27/11/2017 | 2.0 | Configuração de Ambiente | Allan Nobre |
O presente documento tem o objetivo de mostrar os passos necessários para contribuir com o projeto SSMais, por meio da inserção de novas funcionalidades ou ajuste de funcionalidades já existentes no projeto.
O código de conduta para membros que desejam contribuir para este projeto pode ser visto em código de conduta ou no documento CODE OF CONDUCT presente no repositório da implementação do projeto
Para mais informações de como contribuir com este projeto, acesse: CONTRIBUTING.md .
Para realizar a configuração do ambiente necessário para desenvolver o back-end da aplicação pode-se seguir os seguintes passos em seu terminal:
Passo 1
Cheque se o Python3 já está instalado em sua máquina.
$ python3 --version
Passo 2
Se o Pythton3 não estiver instalado, instale-o:
$ sudo apt-get install python3
Feito isso, agora é necessário instalar o ambiente virtual (**virtualenv**).
Passo 3
Cheque se o virtualenv já está instalado em sua máquina:
$ virtualenv --version
Passo 4
Se o virtualenv não estiver instalado, instale-o:
$ sudo apt-get install python-virtualenv
Quando o virtualenv estiver devidamente instalado, exerça os passos seguintes.
Passo 5
Cria um pasta(any name):
$ mkdir projeto
Acesse a pasta criada:
$ cd projeto
Agora crie o ambiente virtual(any name), nesse caso usaremos o nome "virtual":
python3 -m venv virtual
Passo 6
Note que um diretório chamado "virtual" foi criado. Para entrar no ambiente virtual criado rode:
$ source virtual/bin/activate
Após esse passo seu terminal apresentará o nome do ambiente virtual no início da linha de comando, parecido com isso:
(virtual) ~/blabla/projeto $
Passo 7 - Final
Agora, dentro do ambiente virtual, com ele ativado, instale o Django:
(virtual) ~$ pip install django
OBS.: Se o pip não estiver instalado na sua máquina, instale-o:
apt-get install python-pip
OBS.: E para possuir a versão mais atual do pip, rode, ou:
pip install -U pip
ou
pip install --upgrade pip
Pronto! Seu ambiente para desenvolvimento em Django está configurado.
Informação Extra
OBS.: Para sair do ambiente virtual utilize:
(virtual) ~$ deactivate
Após isso seu terminal irá aparecer sem o nome do ambiente em parênteses antes da linha de comando:
~$
OBS: Instale os "requirements" do projeto utilizando o comando (O nome do arquivo de requirements normalmente é "requirements"):
pip install -r <NOME DO ARQUIVO DE REQUIREMENTS>