README.md 4.09 KB
Edit Raw Blame History


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


Templates


list_course.html
create_course.html
update_course.html


Views . py


CourseView()
CourseListView()


Para Classes que envolvem formulários:


CourseFormView()


Forms . py


ListCourseForm()
CreateCourseForm
UpdateCourseForm()


##API Description
We are using mostly viewsets ( http://www.django-rest-framework.org/api-guide/viewsets/) to build our API endpoints now, so all default methods and API points were kept.


model list(GET) = list all objects from that mode in pagination mode, each page has 10
model detail(GET) = give the details of the objects and most important fields of the ones objects its has relationships.
model create


Courses (URL: coursesapi)


course list ("/coursesapi/")
course detail ("/coursesapi/id") (id is a parameter)


Subject (URL: subjectapi)


subject list ("/subjectapi/")
subject detail ("/subjectapi/id") (id is a parameter)


Topic (URL: topicsapi)


topics list ("/topicsapi/")
topic detail ("/topicsapi/id") (id is a parameter)


logs (URL: logs)


logs list ("/logs/")
log detail ("/logs/id") (id is a parameter)


#Obtaining an Access Token


First build an application o "amadeus/o/applications" following this tutorial: http://django-oauth-toolkit.readthedocs.io/en/latest/tutorial/tutorial_01.html#create-an-oauth2-client-application
Then request, using a valid user, an access token using the following template (you'll have to know how to translate a GET Method into a POST one)
curl -X POST -d "grant_type=password&username=&password=" -u":" http://amadeus/o/token/
finally, with your access token you can use test using 
curl -H "Authorization: Bearer " -X POST -d"username=foo&password=bar" http://localhost:8000/users/ (inserting a new user)

Link's úteis
Git - Introdução e comandos básicos(PT-BR)

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

Django Breadcrumbs
Sprint WorkFlow
[PT-BR]
Dia : Atividade


01 Segunda: Retrospective/Planning
05 Sexta: Review
08 Segunda: Weekly Meeting
11 Quinta: Sprint Deadline
12 Sexta: Review/Deploy


[EN-US]

Day  : Activity


01 Monday: Retrospective/Planning
05 Friday: Review
08 Monday: Weekly Meeting
11 Thursday: Sprint Deadline
12 Friday: Review/Deploy