Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 4.5 KB

README.md

File metadata and controls

62 lines (44 loc) · 4.5 KB

Build Style Tests

API de Gerenciamento de Usuários do SysArq

codecov Quality Gate Status Security Rating Maintainability Rating Reliability Rating

Bugs Vulnerabilities Code Smells Technical Debt Lines of Code Duplicated Lines (%)

A API de Gerenciamento de Usuários do SysArq compõe a arquitetura de microsserviços do sistema SysArq.

Esse microsserviço é responsável pelo CRUD (veja a definição), autenticação e gerenciamento de permissões de usuário da aplicação. Saiba mais

Execução

Requisitos

Executar

  1. Clone esse repositório - veja como clonar um repositório;

  2. Crie, utilizando o arquivo env-reference, o .env dentro da pasta do repositório;

  3. Execute, dentro da pasta do repositório, o comando:

     sudo docker-compose up
    
  4. Acesse http://0.0.0.0:8001/ no navegador.

Testes e Verificação de Estilo

  • Para testar a aplicação, utilize o pytest. Por exemplo:

       sudo docker-compose run web pytest --cov
    

    Observação: Só serão aceitas contribuições com 90% de cobertura de código.

  • Para verificar o estilo de código da aplicação, utilize o flake8. Por exemplo:

       sudo docker-compose run web flake8
    

    Observação: Só serão aceitas contribuições com o estilo correto.

ATENÇÃO: Execute os comandos dentro da pasta do repositório.

Documentação

Como contribuir