Português (BR) | English (US)

Querido Diário Backend (operações internas)

Dentro do ecossistema do Querido Diário, este repositório é o responsável por operações internas do site do Querido Diário como interações com bancos de dados, etc.

Conheça mais sobre as tecnologias e a história do projeto.

Sumário

• Como contribuir
• Ambiente de desenvolvimento
• Como executar
• Suporte
• Agradecimentos
• Open Knowledge Brasil
• Licença

Como contribuir

Agradecemos por considerar contribuir com o Querido Diário! 🎉

Você encontra como fazê-lo no CONTRIBUTING.md!

Além disso, consulte a documentação do Querido Diário para te ajudar.

Ambiente de desenvolvimento

Para configurar o ambiente de desenvolvimento, é necessário Python (3.6+) e o gestor de containers podman (4.3.0+).

Por meio de um terminal aberto no diretório raíz do repositório, use a sequência de comandos a seguir para instalar as dependências e interagir com a interface de linha de comando em sistema operacional Linux.

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
python -m cli setup --migrate --superuser

Agora os containers já estão rodando!

Como executar

Para configurar o projeto corretamente, os arquivos .env e .postgres.env devem ser criados no diretório app e as variáveis modificadas para os valores desejados. Os arquivos .example.env e .example.postgres.env estão disponíveis para serem utilizados como base.

O comando a seguir garante que o projeto será executado novamente com a variáveis de ambiente corretas.

python -m cli setup --force-recreate

Para mais informações sobre configurações do servidor, execute:

python -m cli setup --help

Pronto! Agora você já pode simular as alterações, vendo como as modificações feitas no código refletem no site, antes de enviar sua contribuição!

Suporte

Ingresse em nosso canal de comunidade para trocas sobre os projetos, dúvidas, pedidos de ajuda com contribuição e conversar sobre inovação cívica em geral.

Agradecimentos

A aplicação foi inicialmente desenvolvida junto às pessoas do estúdio de software Jurema.

Este projeto é mantido pela Open Knowledge Brasil e possível graças às comunidades técnicas, às Embaixadoras de Inovação Cívica, às pessoas voluntárias e doadoras financeiras, além de universidades parceiras, empresas apoiadoras e financiadoras.

Conheça quem apoia o Querido Diário.

Open Knowledge Brasil

A Open Knowledge Brasil é uma organização da sociedade civil sem fins lucrativos, cuja missão é utilizar e desenvolver ferramentas cívicas, projetos, análises de políticas públicas, jornalismo de dados para promover o conhecimento livre nos diversos campos da sociedade.

Todo o trabalho produzido pela OKBR está disponível livremente.

Licença

Código licenciado sob a Licença MIT.