From b29602f1a13e865bf7b0d5f94c5b1a6269ea1a9f Mon Sep 17 00:00:00 2001 From: Igor Barcik Date: Tue, 28 Apr 2026 13:22:02 +0200 Subject: [PATCH] docs: replace Redis with channels_postgres in README --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 07d0385..98b9b0b 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Stworzenie webowej aplikacji komunikacyjnej inspirowanej platformą Discord. Apl 3. **Komunikacja** - Kanały publiczne/grupowe: tworzenie, dołączanie, historia wiadomości - Wiadomości prywatne (DM) między dwoma użytkownikami - - Obsługa czasu rzeczywistego (WebSocket, np. Django Channels + Redis) + - Obsługa czasu rzeczywistego (WebSocket, np. Django Channels + PostgreSQL) 4. **Multimedia** - Wiadomości tekstowe, obrazy, nagrania audio (pliki dźwiękowe) @@ -45,7 +45,7 @@ Stworzenie webowej aplikacji komunikacyjnej inspirowanej platformą Discord. Apl ### Backend - Framework: **Django** (zalecane rozszerzenia: Django REST Framework, Django Channels) -- WebSocket do komunikacji w czasie rzeczywistym (np. z użyciem Redis jako warstwy kanałów) +- WebSocket do komunikacji w czasie rzeczywistym (z użyciem PostgreSQL jako warstwy kanałów – `channels_postgres`) - Obsługa przesyłania plików (obrazy, audio) - Własna strona błędu 404 i 500 @@ -57,7 +57,7 @@ Pliki wymagane w repozytorium: - `docker-compose.yml` – definiujący wszystkie usługi niezbędne do działania systemu, co najmniej: - `web` – serwer Django (z obsługą ASGI np. Daphne/Uvicorn dla WebSocket) - `db` – baza danych PostgreSQL - - `redis` – serwer Redis (dla Django Channels) + - `db` – baza danych PostgreSQL (używana również jako warstwa kanałów dla Django Channels via `channels_postgres`) - Plik `.env` lub komentarze w `docker-compose.yml` wskazujące, jak skonfigurować zmienne środowiskowe (np. `SECRET_KEY`, dane dostępowe do bazy) Uruchomienie aplikacji sprowadza się do: @@ -82,7 +82,7 @@ Po starcie wszystkie migracje powinny zostać wykonane automatycznie, a aplikacj docker-compose up --build ``` 3. **Automatyczna inicjalizacja**: - - Uruchomi się baza danych PostgreSQL, serwer Redis oraz serwer webowy Daphne. + - Uruchomi się baza danych PostgreSQL oraz serwer webowy Daphne. - Migracje bazy danych zostaną wygenerowane i zaaplikowane automatycznie. - Domyślne konto **Administratora** zostanie stworzone. 4. **Dostęp do aplikacji**: @@ -106,7 +106,7 @@ Po starcie wszystkie migracje powinny zostać wykonane automatycznie, a aplikacj Projekt w pełni realizuje założenia: 1. **System użytkowników**: Wbudowana rejestracja, logowanie, walidacja unikalności oraz panel edycji profilu (awatar, opis). 2. **Role i uprawnienia**: Działają 3 wymagane role (Admin, Moderator, Użytkownik). Backend skutecznie weryfikuje uprawnienia. -3. **Komunikacja w czasie rzeczywistym**: Wiadomości w kanałach publicznych oraz DM opierają się na technologii WebSockets (Django Channels + Redis). +3. **Komunikacja w czasie rzeczywistym**: Wiadomości w kanałach publicznych oraz DM opierają się na technologii WebSockets (Django Channels + `channels_postgres`). 4. **Multimedia**: Dodano obsługę przesyłania plików, które od razu po przesłaniu wyświetlają się innym użytkownikom jako obrazy lub odtwarzacze audio. 5. **Moderacja**: Administrator/Moderator może usuwać niepożądane wiadomości oraz całkowicie blokować dostęp wybranym użytkownikom. -6. **Środowisko Docker**: Całość działa w odseparowanych kontenerach (web, db, redis) uruchamianych jednym poleceniem, z automatycznymi migracjami i początkowym seedowaniem bazy. \ No newline at end of file +6. **Środowisko Docker**: Całość działa w odseparowanych kontenerach (web, db) uruchamianych jednym poleceniem, z automatycznymi migracjami i początkowym seedowaniem bazy. \ No newline at end of file