discentes-imd / IntegraTI-API

API RESTful para o projeto IntegraTI
https://api-integrati.herokuapp.com/
GNU General Public License v3.0
6 stars 0 forks source link

Alterar o readme #2

Closed rodrigondec closed 7 years ago

rodrigondec commented 7 years ago

Alterar o arquivo readme para explicar como rodar a aplicação flask

Mazuh commented 7 years ago

Falta só citar sobre a instalação do bd e qual sgdb o computador deve ter.

(E aí escrevo algumas considerações a serem tomadas, no Linux quem não é familiarizado com py/virtualenv/pip pode ser induzido a alguns erros na hora de instalação.)

rodrigondec commented 7 years ago

Seguindo os passos que eu coloquei lá no readme não tem como errar, tanto no linux quanto windows ;)

Mazuh commented 7 years ago

Tem, home. kk Já vi nos minicursos vários erros de quem não é acostumado com o mundo Python (inclusive erros meus quando tentei começar sozinho). Mas por um bom tempo, enquanto formos só nós, assim é suficiente. Tô comentando aqui na issue pra deixar documentado a lembrança.

Mazuh commented 7 years ago

Hoje à noite irei refazer os passos (troquei hd, lembra?) e checar para erros. No momento, já identifiquei com o Weslen que precisa dizer mais sobre a conexão ao banco de dados. Qual arquivo o usuário precisa mexer, qual sgbd etc.

rodrigondec commented 7 years ago

Sobre o banco de dados, a conexão é feita na linha 10 do config.py.

O sgbd é MySQL. Pra funcionar corretamente precisa configurar o MySQL na máquina local e criar o database IntegraTI. Não precisa criar as tabelas, apenas o database. Do resto o SQLAlchemy cuida.

Atentar para os parâmetros de login e senha do MySQL na conexão, recomendo todos utilizarem esse dai que está no código.

Coloque no readme tbm a questão do python manager.py db init, python manager.py db migrate e python manager.py db upgrade. Que são os comandos pra gerenciar as migrações dos models no bd.

Mazuh commented 7 years ago

@rodrigondec, descreva melhor o que os comandos do python mange.py fazem lá no readme.