Skip to content

Claayton/BillFlux

Repository files navigation

💸 BillFlux

MIT License GitHub issues GitHub stars GitHub last commit Code Style Black

📋 Features

  • Sistema para gerenciamento e administração de boletos e contas a pagar, com o objetivo de ser simples, direto e usual. As principais funcionalidades incluem:
    • Desenvolvido em Python/Flask
    • Realizar CRUD de usuários
    • Geração de código de barras para facilitar o pagamento, evitando a necessidade de digitar o código manualmente no smartphone ou de utilizar o boleto em papel

🚀 Quick Start

O projeto foi desenvolvido em um sistema operacional Linux Mint 22, utilizando a versão 3.10.2 do Python. As instruções devem funcionar em qualquer sistema baseado no Ubuntu e com qualquer versão do Python acima da 3.8, mas é recomendado utilizar um ambiente o mais semelhante possível para evitar conflitos.

Eu utilizei pyenv para instalar o Python, mas você pode utilizar o site oficial se preferir.

Ambiente Virtual

É uma boa prática criar um ambiente virtual para isolar o projeto da sua máquina e evitar conflitos. Para instalar o virtualenv, caso ainda não tenha, utilize:

sudo pip3 install virtualenv

Agora configure seu ambiente virtual para evitar possiveis conflitos:

python3 -m venv venv 

Em seguida você deverá ativar esse ambiente:

source venv/bin/activate 

Agora instale as bibliotecas e pacotes necessários para rodar o projeto:

pip3 install -r requirements.txt

🎉 O projeto já está configurado e pronto para ser testado em modo de desenvolvedor:

flask --app run run --debug

⚙️ Tests

Utilizar para esse projeto o pytest para fazer os testes necessários, para executar os testes utilize:

  # Rodar os testes + cobertura, mostrando os detalhes caso ocorra algum erro:
  pytest -v

About

A manager for tickets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published