yagopeixinho / veiacoBackend

Backend API do projeto Veiaco — Um sistema em que você gerencia as pessoas as quais você emprestou aquela grana!

Veiaco: porque gerenciar dívidas de amigos nunca foi tão fácil (ou menos constrangedor)

Note Lamentamos informar que a inclusão da logomarca do aplicativo encontra-se indisponível no momento.

Restful API para o projeto Veiaco - veiaco

Esse é o back-end do projeto Veiaco! Cheque veiacoPlataforma para mais informação

Instalação  

Antes de rodar o front-end projeto, é necessário ter instalado em sua máquina:

• Git
• MySQL

Clonando repositório

$ git clone [e-mail]:yagopeixinho/veiacoBackend.git

Ambiente Virtual

• No diretório do projeto que foi clonado, crie um ambiente virtual

$ python3 -m venv venv
# Esse comando vai criar um ambiente virtual

$ source venv/bin/activate
# Esse comando vai ativar o ambiente virtual que foi criado anteriormente

• Instale as dependências utilizando o pip

$ pip3 install -r requirements.txt
# Isso vai instalar todas as dependências para rodar o projeto

Variáveis de Ambiente

• Para iniciarmos o projeto precisamos declarar algumas variáveis de ambiente responsáveis pela definição de informações importantes, como o ponto de entrada do APP e SECRET_KEY

# No diretório do projeto crie o arquivo responsável pela definição das variáveis de ambiente
$ touch .env

• Dentro do arquivo .env cole as variáveis de ambiente mínimas para rodar o projeto

# Para encriptar as senhas dos usuários
SECRET_KEY="escolhaUmaSenhaSegura"

# Ponto de entrada para rodar o APP
FLASK_APP="veiaco.py"

Banco de Dados

• Dentro do CLI do MySQL, crie o banco de dados localmente

mysql> CREATE DATABASE veiaco;

• O Banco de Dados foi criado, porém ainda não possui nenhuma tabela ou informação. Esse é o trabalho do Flask-Migrate. Dentro do back-end:

$ flask db upgrade