⚙️ Microserviço de usuários

Bem-vindo a API de usuário! Este espaço foi criado como um estudo de caso do uso do Flask com boas práticas de programação.

🎯 Objetivo

O objetivo deste projeto é demonstrar o uso de boas práticas de programação, incluindo os princípios SOLID, Clean Code, Clean Architecture e Design Patterns, aplicados ao uso de Python com Flask, para garantir uma estrutura de código organizada, escalável e de fácil manutenção. O serviço é projetado para suportar operações CRUD básicas de usuários e foi estruturado com foco na separação de responsabilidades e inversão de dependências, buscando maximizar a qualidade e a clareza do código.

🛠 Tecnologias

As tecnologias utilizadas nesse projeto foram:

📥 Instalação

Sigo os passo abaixo para pode instalar o projeto na máquina alvo.

Passo 1: Download

O primeiro passo é o download do projeto para a máquina alvo. Para isso é necessário que você tenha o Git instalado e uma conta no GitHub.

Com esses requisitos atendidos, uma das formas de fazer o download dos arquivos do projeto é via SSH. Caso ainda não tenha, cadastre uma chave SSH na máquina alvo e a chave pública no GitHub, e após faça o clone do projeto seguindo a instrução abaixo:

  git clone git@github.com:dbrazl/api-user-microservice.git

Passo 2: Ambiente virtual

Com o projeto na máquina alvo, você pode criar um ambiente virtual para instalação dos pacotes, o que eu fortemente recomendo. Caso não queira, pule para o próximo passo.

Para se criar um ambiente virtual, você deve rodar o seguinte comando:

  python -m venv .venv

Após rodá-lo, um novo diretório nomeado como .venv aparecerá na pasta raiz do projeto. Usaremos esse ambiente para rodar a aplicação Python.

Para iniciar o ambiente, use o seguinte comando no terminal para máquinas Linux:

  source .venv/bin/activate

Já para desativá-lo, use o seguinte comando:

  deactivate

Para o próximo passo, mantenha o ambiente virtual ativo. Usar um ambiente virtual evita conflito de pacotes do Python com outros projetos do seu sistema.

Após finalizar a aplicação, lembre-se de desativar o ambiente virtual.

Passo 3: Instalação de pacotes

Para instalar os pacotes do projeto, use o seguinte comando na raiz do projeto:

  pip install -r requirements.txt

🚀 Como Rodar

Com a etapa de instalação finalizada, crie uma copia do arquivo .env.example na raiz do projeto, e o renomeie para .env. Após isso, altere as variáveis ambientes para a de sua preferência.

Por fim, inicie a aplicação rodando o seguinte comando abaixo:

  python entry.py

📚 Documentação

Em breve estará disponível.

📬 Contato

Se você tiver dúvidas ou sugestões, pode me encontrar em daniel.braz@vyox.io ou através do LinkedIn.