Diarios-Oficiais-ALEMS/README.md

# Diários Oficiais ALEMS

Indexação dos Diários Oficiais da ALEMS

[![Built with Cookiecutter Django](https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter)](https://github.com/cookiecutter/cookiecutter-django/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

## Configurações

Consulte [settings](https://cookiecutter-django.readthedocs.io/en/latest/1-getting-started/settings.html).

## Comandos Básicos

### Configuração de Usuários

- Para criar uma **conta de usuário normal**, vá para Cadastrar e preencha o formulário. Após enviar, você verá uma página "Verifique Seu Endereço de E-mail". Verifique no console a mensagem simulada de verificação de e-mail. Copie o link no seu navegador. Agora o e-mail do usuário estará verificado e pronto para uso.

- Para criar uma **conta de superusuário**, use o comando:

      $ python manage.py createsuperuser

Para conveniência, você pode manter seu usuário normal logado no Chrome e seu superusuário logado no Firefox (ou similar), para ver como o site se comporta para ambos os tipos de usuários.

### Verificação de Tipos

Executando verificação de tipos com mypy:

    $ mypy diários_oficiais_alems

### Cobertura de Testes

Para executar os testes, verificar a cobertura e gerar um relatório HTML de cobertura:

    $ coverage run -m pytest
    $ coverage html
    $ open htmlcov/index.html

#### Executando testes com pytest

    $ pytest

### Recarregamento automático e compilação Sass CSS

Consulte [Live reloading and SASS compilation](https://cookiecutter-django.readthedocs.io/en/latest/2-local-development/developing-locally.html#using-webpack-or-gulp).

## Deploy

A seguir estão os detalhes para fazer o deploy desta aplicação.

### Docker

Consulte a [documentação Docker do cookiecutter-django](https://cookiecutter-django.readthedocs.io/en/latest/3-deployment/deployment-with-docker.html).