README_pt-br.md

tjas-erp

⭐ Marque o projeto com uma estrela. 👀 Acompanhe o projeto para receber novidades.

🇺🇸 Access this page in US English.

Aplicação ERP Python/Django avançada para cadastro, detalhamento, edição, exclusão e listagem de produtos, funcionários e vendas, com controle de acesso. As funcionalidades e evoluções previstas podem ser encontradas na seção Principais Funcionalidades Disponíveis.

Principais Funcionalidades Disponíveis

Para saber mais sobre lançamentos futuros, acesse o Planejamento de Lançamentos

• Cadastro, detalhamento, edição e listagem de funcionários;
• Cadastro, detalhamento, edição, exclusão e listagem de produtos;
• Cadastro, detalhamento, edição, exclusão e listagem de vendas;
• Controle de acesso de páginas públicas e privadas;
• Conexão para persistência de informações em base de dados local;
• 76% de cobertura de testes.

Utilização

Este é um exemplo de como você pode configurar o projeto localmente no seu computador. Recomendamos fortemente que você utilize um ambiente virtual para rodar a aplicação, recomendamos a utilização do Virtualenv (ou qualquer outro de sua preferência). Leia, crie e ative o ambiente virtual dentro da pasta do projeto antes do passo 5.

Para obter uma cópia local funcionando, siga estas etapas:

1. Certifique-se de que você tem o Python 3.10.11+ instalado ou verifique como fazê-lo em Python.org ou por meio do Anaconda;
2. Certifique-se de que você tem o Git instalado ou verifique como fazê-lo em Git-scm.com;
3. Acesse a pasta na qual você deseja salvar o projeto, então, clone o repositório nesta pasta

   git clone https://github.com/tjas/tjas-erp

4. Acesse a pasta do projeto;
5. Instale as dependências do projeto

   pip install -r requirements.txt

6. Certifique-se de que o PostgreSQL está rodando em sua máquina e que o banco de dados db_erp foi criado. O nome, os dados de acesso ao banco de dados e demais configurações devem ser verificadas e podem ser alteradas na variável DATABASES do arquivo settings.py, localizado na pasta principal (módulo core) da aplicação.
7. Execute as migrations

   python manage.py migrate

8. Execute o projeto Django

   python manage.py runserver

9. Finalmente, acesse a aplicação no endereço: http://127.0.0.1:8000/

Contribuição

1. Crie um fork!
2. Crie sua branch de funcionalidade:

   git checkout -b minha-nova-funcionalidade

3. Adicione os arquivos modificados:

   git add .

4. Faça um Commit com suas alterações:

   git commit -m "Adicione algum comentário útil aqui"

5. Faça um push da sua branch:

   git push origin minha-nova-funcionalidade

6. Envie um Pull Request para esse repositório
   • Adicione um título e uma descrição que deixe claro sua sugestão;
   • Utilize o idioma inglês para comentários e nomes de branch;
   • Depois que seu pull request for mergeado, você pode apagar sua branch.

Testes

Para a criação de testes unitários foram utilizadas, principalmente, as ferramentas disponíveis no módulo django.test do Django e na biblioteca unittest do Python. Para aferir a cobertura de testes foi utilizado o pacote coverage.

Realização de testes

De dentro da pasta do projeto execute:

python manage.py test

Verificação da cobertura de testes

De dentro da pasta do projeto execute a ferramenta e gere relatórios:

coverage run --omit='*/venv/*' manage.py test
coverage report
coverage html

Contato

Thiago Jorge Almeida dos Santos, autor e mantenedor do projeto.

Licença

• Código distribuído sob a Licença MIT.