Skip to content

watchdogpolska/feder

Repository files navigation

image

image

image

devDependency Status

Feder

Mechanizm do automatycznego wysyłania wniosków o informację do dużej liczby podmiotów, automatycznego przyjmowania odpowiedzi, udostępnienia otrzymanych odpowiedzi do analizy pod wybranym kątem przez masowo angażowanych do tego zadania obywateli oraz upubliczniania zweryfikowanych odpowiedzi i zestawień uzyskanych danych.

Testowanie w lokalnym środowisku

Zbudowanie usługi:

make build  # zbudowanie wszystkich zależności; może zająć trochę czasu przy pierwszym wywołaniu
make wait_web  # inicjalizacja lokalnych zależności
docker-compose up  # inicjalizacja samej aplikacji; po wykonaniu, aplikacja powinna być widoczna w localhost:8000

Inicjalizacja bazy danych:

make importterc  # wypełnienie bazy jednostek organizacyjnych
make createsuperuser  # stworzenie konta administratora

Inicjalizacja jest konieczna przed pierwszym użyciem. W trakcie wywoływania komend aplikacja powinna działać w tle, tj. wcześniej należy wywołać komendę

docker-compose up

Statyczna kontrola kodu

Statyczna kontrola kodu w projekcie służy do sprawdzenia, czy kod spełnia określone standardy jakości.

Wszystkie sprawdzenia kodu statycznego można uruchamiać za pomocą pre-commit run. Są one także weryfikowane w środowisku GitHub Actions, przy każdej propozycji zmian zawartości repozytorium.

W celu instalacji narzędzia do statycznej kontroli kodu, należy wykonać:

pip install -r requirements/dev.txt

W celu wykonania kontroli statycznej kodu, należy wykonać:

git add .
make lint

Aby włączyć automatyczne sprawdzanie kodu przed stworzeniem zmiany (commit), należy wykonać:

pre-commit install