Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dadosabertosdefeira/laia
Cadastre e acompanhe o status dos seus pedidos de informação 📃
https://github.com/dadosabertosdefeira/laia
hacktoberfest lai lei-de-acesso-a-informacao tecnologias-civicas transparencia
Last synced: 2 months ago
JSON representation
Cadastre e acompanhe o status dos seus pedidos de informação 📃
- Host: GitHub
- URL: https://github.com/dadosabertosdefeira/laia
- Owner: DadosAbertosDeFeira
- License: mit
- Created: 2021-07-16T17:09:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T23:14:17.000Z (over 1 year ago)
- Last Synced: 2024-05-22T21:26:26.730Z (8 months ago)
- Topics: hacktoberfest, lai, lei-de-acesso-a-informacao, tecnologias-civicas, transparencia
- Language: Python
- Homepage: https://dadosabertosdefeira.github.io/laia/
- Size: 614 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laiá
[](https://github.com/DadosAbertosDeFeira/pedidos/actions/workflows/ci.yml)
[](https://github.com/DadosAbertosDeFeira/laia/actions/workflows/push-docker-image.yml)
Cadastre e acompanhe o status dos seus pedidos de informação 📃✨
----
## Configurando seu ambiente
### Carregue as variáveis de ambiente
Para a aplicação funcionar, é necessário criarmos um arquivo `.env`, um arquivo de configuração que é individual por possuir dados sensíveis.
Para configurar sua `.env`, busque pelo exemplo de configuração `.env.example` na raiz do projeto,
faça uma cópia e deixe o arquivo com a extensão `.env`.
Para rodar o projeto Laiá, você pode instalar o [Poetry](https://python-poetry.org/docs/master/#installation),
para conseguir instalar automaticamente todas as dependências do projeto.
A execução é feita com [Docker](https://www.docker.com/) e [docker-compose](https://docs.docker.com/compose/).
### Instale as dependências do projeto
```bash
poetry install
```
### Utilizando docker-compose
```bash
docker-compose up --build
```
Para aplicar as migrations, execute:
```bash
make migrate
```
Outros atalhos podem ser vistos em nosso [Makefile](Makefile).
### Rodando os testes
Você pode executar os testes no ambiente virtual criado pelo Poetry
com `pytest` ou rodando `make tests` para executar os testes dentro do container.
### Configure o pre-commit
Instale o pre-commit localmente rodando `pre-commit install`. Dessa forma,
o código que você commitar já estará formatado, com os imports ordenados e mais arrumado.
### Rode o shell do Poetry e inicie o ambiente virtual.
```bash
poetry shell
```
### Crie um usuário para incluir seus pedidos
```bash
make createsuperuser
```
#### Aplique as migrations
```bash
make migrate
```
## Rodando a aplicação
```bash
make run
```
Acesse [localhost:8000](http://localhost:8000).
## Deploy
Atualmente estamos fazendo o deploy manual dessa aplicação.
Para isso, precisamos fazer o pull do código e reiniciar
a aplicação para que ela seja atualizada.
Para preparar o código para atualização é preciso que você:
* Atualize as dependências:
```bash
poetry export --without-hashes --format=requirements.txt > requirements.txt
```
* Atualize as variáveis de ambiente no `.env` do servidor
* Reinicie o serviço