System służący do usprawnienia obiegu dokumentów Stowarzyszenia, w szczególności w zakresie:
system rozwijany będzie małymi etapami, aby jak najszybciej dostarczał wartość dla biura Stowarzysznia
w początkowych etapach system będzie przeznaczony do archiwizacji dokumentów pochodzących z różnych mediów
w przyszłości system będzie służył także do:
należy w trakcie rozwoju zachować ciągłość funkcjonowania procesów Stowarzyszenia
system trwale będzie miał charakter wewnętrzny dla Stowarzyszenia
Platforma udostępnia skuteczne API w celu umożliwienia powstania wokół systemu integracji
Uwierzytelnienie z wykorzystaniem GSuite
System składa się z następujących komponentów:
backend-project
frontend-project
Dodatkowe uwagi:
Stowarzyszenie prowadziło jedynie rejestr korespondencji w oparciu o interfejs webowy dla dwóch tabelach SQL (przychodzące i wychodzące)
Opracowano small_eod v1, który umożliwiał rejestracje rejestracje dokumentów papierowych i rejestracje spraw. Całość została wykonana w oparciu o django-admin
, co ograniczało rozwój, lecz pozwoliło na poznanie podstawowych koncepcji.
Rozpoczęto opracowanie small_eod v2, który stanowić ma trwałe rozwiązanie dla Stowarzyszenia poprzez m. in.: elastyczny interfejsu użytkownika nie opartego o django-grappeli
, w szczególności umożliwiającego:
Szczegółowe założenia i wymagania dla small_eod v2 zostały przedstawione w docs
.
W celu rozwoju projektu kod źródłowy projektu można pobrać za pomocą komendy git:
git clone git@github.com:watchdogpolska/small_eod.git
W przypadku pracy w środowisku Windows/Mac można wykorzystać GitHub Desktop. W celu pobrania należy postępować zgodnie z instrukcją.
Projekt realizowany jest zgodnie z filozofią open-source. Szczegółowe informacje na temat:
Zadania do wykonania są zarejestrowane jako zagadnienia oznaczone etykietą good first issue w portalu GitHub. W celu ich realizacji wystarczy komentarz o rozpoczęciu prac, a następnie utworzenie żądania wcielenia zmian (pull request).
Bieżąca komunikacja projektu odbywa się z wykorzystaniem Slacka organizacji CodeForPoznań na kanale #watchdog. Odbywają się regularne spotkania statusowe (szczegóły w zagadnieniu https://github.com/watchdogpolska/small_eod/issues/547), gdzie można uzyskać wprowadzenie w projekt, dowiedzieć się na temat zadań i usunąć inne trudności we współpracy.
W celu ułatwienia rozwoju projektu wykorzystywane jest oprogramowanie Docker. Umożliwia ona uruchomienie wszystkich usług niezbędnych do pracy nad projektem. Usługi zostały opisane w pliku docker-compose.yml
.
W celu uruchomienia środowiska aplikacji wymagane jest:
Aby dowiedzieć się więcej o oprogramowaniem zapoznaj się z wideo Docker dla webdevelopera - #01 - Czym jest Docker?.
W celu uruchomienia projektu należy wykonać:
docker-compose up
Po pomyślnym uruchomieniu projektu środowisko pod adresem http://localhost:8000/ winno być możliwe korzystanie z aplikacji poprzez konto testowego, automatycznie stworzonego użytkownika. Kwestia autoryzacji opisana jest szerzej w folderze fake-oauth/. Wszelkie zmiany kodu aplikacji w lokalnym repozytorium będą automatycznie załadowane przez Django.
W celu utworzenia konta administratora należy wykonać:
docker-compose run backend python manage.py createsuperuser
W celu utworzenia próbnych danych należy wykonać:
docker-compose run backend python manage.py init_data
W razie problemów z uruchomieniem projektu utwórz nowe zagadnienie
Projekt wykorzystuje testy automatyczne, które zapewniają weryfikacje wszystkich wprowadzonych zmian. Wszelkie proponowane zmiany z wykorzystaniem GitHub Actions.
Wszelkie zmiany w repozytorium będą uruchamiały serie testów automatycznych, ale przed ich dodaniem masz możliwość wykonania testów lokalnie za pomocą Makefile.
W celu wykonanie testów automatycznych formatowania należy wykonać:
make lint
Większość problemów w formatowania można naprawić z wykorzystaniem automatycznego formatowania za pomocą wykonania:
make fmt
W celu wykonania testów automatycznych back-endu należy wykonać:
make test-django-backend
Każda zmiana znajdująca się na gałęzi dev
jest wdrażana z wykorzystaniem GitHub Actions do usługi Rejestr od HyperOne, która jest usługą docker-registry-as-a-service.
Dla potrzeb środowiska testowego (dev.small-eod.siecobywatelska.pl
) i preprodukcyjnego (dev.small-eod.siecobywatelska.pl
) w HyperOne zostały uruchomione:
frontend
, backend
i balancer
w klasycznej infrastrukturze Stowarzyszenia (bazującej na Wirtualnych Maszynach HyperOne)Publiczny dostęp do środowiska testowego odbywa się z wykorzystaniem adresu: dev.small-eod.siecobywatelska.pl
. Dostępne jest konto użytkownika root
z hasłem root
. W przypadku uszkodzenia konta – utwórz nowe zagadnienie lub napisz na Slacku.
Projekt wspierany jest przez firmę Vercel