API em Python com Flask e MongoDb 🐍

API construida em python para prover todo o backend da aplicação do projeto Neo3.

⚡ Instalação

Pré-requisitos

• Python
• Flask

Nota: É recomendável o uso de virtualenv.

Iniciando

Antes de tudo, é necessárior fazer o download do repositório.

$ git clone [email protected]:Neoenergia-3/backend.git

Depois, tenha certeza que está dentro do diretório do repositório.

$ cd <caminho/para/backend>

Caso você queira utilizar um ambiente virtual, pode rodar os camandos abaixo:

# Configura o ambiente virtual no diretório atual
$ python3 -m venv ./venv 

# Inicia o ambiente virtual
$ . venv/bin/activate

Configurando

Esta é uma API construida em python, juntamente com flask, por isso é necessário instalar o flask e as outras dependências do projeto.

O que pode ser feito pelo seguinte comando:

$ pip3 install -r requirements.txt 

Para prover todo o sistema de armazenamento de dados esta API ultiliza um banco de dados, chamando MongoDB 💜, portanto é necessário conectar o python ao MongoDB.

E para isso você precisa substituir a variável "MONGO_URI" com a url da sua conexão.

Nota: Se você não sabe como conseguir o url de conexão do MongoDB da uma olhada nesse site.

Pronto! Agora o projeto já está configurado e pronto para uso.

💻 Rodando

Agora que o projeto ja está configurado e pronto para uso só precisa colocar para rodar.

E para isso basta rodar o seguinte comando:

# No diretório da aplicação execute:
$ python3 server.py     

Nota: Se estiver usando um ambiente virtual, execute este comando dentro dele.