1CKomunikator 💬

• Ważne
• Instalacja
• Dokumentacja
• Diagram Bazy Danych
• Postęp:
• Cele
• Do Zrobienia
• Znane Błędy
• README na Github Mobile

Ważne ❗

Przed pull-request sparawdź składnie oraz uruchom testy
Prace nad HTML: dev-html (w trakcie)
Prace nad Bazą Danych: dev-database (w trakcie)
Prace nad Serwerem: dev-server (w trakcie)

Po skończeniu pracy pull-request do dev.

Instalacja 💽

pip install -r requirements.txt

Testowanie 📋

testowanie lokalnie

UWAGA! OBECNIE NIE DZIAŁA

pip install pytest
pytest

testowanie tak jak na github

wymagany jest docker
(polecam docker desktop)
zainstaluj act
uruchom docker [desktop] oraz wywołaj \

act

Sprawdzanie składni 📠

pip install pylint
git ls-files '*.py' | xargs pylint

pip install ruff
ruff . --fix

pip install mypy
mypy --install-types
mypy .

Dokumentacja 🗂️

jak coś się zrobi to dać dokumentację

db.py 📑

zarządza bazą danych

db.py clear - clears the database db.py add - adds a user db.py print_table - prints all users db.py get - gets password about

Postęp: $$25\frac{0}{1}\%$$

Postępy 🏆

Podstawa serwera 🌐

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Obsługa bazy danych 📠

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Działające API - Weryfikacja danych 🗂️

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Działające API - Obsługa wiadomości 💬

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Szyfrowanie 📟

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Inne g$%&a 🥚

• $$\color{green} Całość \space gotowa \space (100\%)$$
• $$\color{yellow} Większość \space gotowa \space (~75\%)$$
• $$\color{orange} Połowa \space gotowa \space (~50\%)$$
• $$\color{red} Mniejszość \space gotowa \space (~25\%)$$
• $$\color{purple} Nic \space nie \space jest \space gotowe \space (0\%)$$

Cele 🏅

• API po stronie serwera, obłsugujące logowanie i tworzenie kont, czy ktos to wgl czyta, wysyłanie, pobieranie, zarządzanie, odpowiadanie - wiadomości
• Szyfrowanie wiadomości, zabezpieczemie przed możliością odczytu po stronie serwera
• Strona aplikacji obsługująca całe API

Do Zrobienia 🧾

• Strona (Serwer) 🌐
• Baza Danych 🗂️
• Szyfrowanie 🔐
• API 📟

Znane Błędy ❗

Docker generated readme

Building and running your application

When you're ready, start your application by running: docker compose up --build.

Your application will be available at http://localhost:8000.

Deploying your application to the cloud

First, build your image, e.g.: docker build -t myapp .. If your cloud uses a different CPU architecture than your development machine (e.g., you are on a Mac M1 and your cloud provider is amd64), you'll want to build the image for that platform, e.g.: docker build --platform=linux/amd64 -t myapp ..

Then, push it to your registry, e.g. docker push myregistry.com/myapp.

Consult Docker's getting started docs for more detail on building and pushing.

References

• Docker's Python guide