Download as
Browse Code »

Commit 9dbacbb786234ef4fbebb9ea8510f370d8af2644

Authored by KabuVerdi
1 parent 3b1acbab
Exists in master and in 5 other branches amadeus_univasf, dev, image-crop, pdf_file_html, refactoring

Alterando o README.md

Showing 1 changed file with 86 additions and 1 deletions   Show diff stats
README.md
  Diff comments   View file @9dbacbb
1   -# amadeus_curso
  1 +# Amadeus 0.9
  2 +------
  3 +
  4 + Repositório para o back-end do projetos Amadeus, na versão 0.9
  5 +
  6 +**Linguagem Utilizada no Projeto:**
  7 +* Python 3.5
  8 +* Django 1.9
  9 +
  10 +**Antes de começar o projeto instale:**
  11 +* Python 3.5
  12 +* Pip
  13 +* Virtualenv
  14 +
  15 +***
  16 +
  17 +## 1 - COMEÇANDO O PROJETO
  18 +
  19 +### 1.1 - Clonando o projeto
  20 +
  21 +* Vá para a pasta onde queres guardar o projeto
  22 +* Escolha a opção de clonagem do projeto
  23 +
  24 +#### HTTPS:
  25 +
  26 +```bash
  27 +$ git clone https://github.com/amadeusproject/amadeuslms.git
  28 +```
  29 +
  30 +#### SSH
  31 +
  32 +```bash
  33 +$ git clone git@github.com:amadeusproject/amadeuslms.git
  34 +```
  35 +
  36 +
  37 +### 1.2 Preparando o ambiente
  38 +
  39 +Agora que você já tem o projeto na sua máquina, precisamos preparar um ambiente próprio para as dependências do projeto. Crie um virtualenv com o seguinte comando abaixo:
  40 +
  41 +**OBS:** amadeus_env pode ser qualquer outro nome que você desejar(desde que não contenha caracteres especiais)
  42 +
  43 +```bash
  44 +virtualenv amadeus_env -p python3.5
  45 +```
  46 +ative a virtualenv criada no passo anterior
  47 +
  48 +```bash
  49 +source amadeus_env/bin/activate
  50 +```
  51 +
  52 +Agora vá para a pasta root do projeto clonado e instale as dependências do projeto contidos no arquivo `requirements.txt`
  53 +
  54 +```bash
  55 +pip install -r requirements.txt
  56 +```
  57 +Pronto. Você está apto a contribuir com o projeto.
  58 +
  59 +### 1.3 Padrões de nome para `templates`, `views.py`, `models.py` e `forms.py`
  60 +---
  61 +
  62 +Visando uma melhor organização do código e a total compreensão doque está sendo feito por cada integrante do projeto, é recomendado usar os seguintes nomes de arquivos/classes/funções
  63 +
  64 +1. Templates
  65 +
  66 +* `list_course.html`
  67 +* `create_course.html`
  68 +* `update_course.html`
  69 +
  70 +2. Views . py
  71 +
  72 +* `CourseView()`
  73 +* `CourseListView()`
  74 +
  75 +Para Classes que envolvem formulários:
  76 +* `CourseFormView()`
  77 +
  78 +3. Forms . py
  79 +* `ListCourseForm()`
  80 +* `CreateCourseForm`
  81 +* `UpdateCourseForm()`
  82 +
  83 +## Link's úteis
  84 +[Git - Introdução e comandos básicos(PT-BR)](https://github.com/fernandomayer/git-rautu/blob/master/0_configuracao-inicial.md)
  85 +
  86 +
... ...