README.md 2.15 KB

Amadeus 1.0

Repositório para o back-end do projetos Amadeus, na versão 0.9

Linguagem Utilizada no Projeto:

  • Python 3.5
  • Django 1.9
  • Material Design Bootstrap [2]

Antes de começar o projeto instale:

  • Python 3.5
  • Pip
  • Virtualenv
  • Postgres

1 - COMEÇANDO O PROJETO

1.1 - Clonando o projeto

  • Vá para a pasta onde queres guardar o projeto
  • Escolha a opção de clonagem do projeto

HTTPS:

$ git clone https://github.com/amadeusproject/amadeuslms.git

SSH

$ git clone git@github.com:amadeusproject/amadeuslms.git

1.2 Preparando o ambiente

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:

OBS: amadeus_env pode ser qualquer outro nome que você desejar(desde que não contenha caracteres especiais)

virtualenv amadeus_env -p python3.5

ative a virtualenv criada no passo anterior

source amadeus_env/bin/activate

Agora vá para a pasta root do projeto clonado e instale as dependências do projeto contidos no arquivo requirements.txt

pip install -r requirements.txt

Pronto. Você está apto a contribuir com o projeto.

1.3 Padrões de nome para templates, views.py, models.py e forms.py

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

  1. Templates
  • list_course.html
  • create_course.html
  • update_course.html
  1. Views . py
  • CourseView()
  • CourseListView()

Para Classes que envolvem formulários:

  • CourseFormView()
  1. Forms . py
  • ListCourseForm()
  • CreateCourseForm
  • UpdateCourseForm()

Git - Introdução e comandos básicos(PT-BR)

[2] https://github.com/FezVrasta/bootstrap-material-design

Django Breadcrumbs