biggy/django-discord
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: replace Redis with channels_postgres in README

Browse Source
This commit is contained in:
biggy
2026-04-28 13:22:02 +02:00
parent ced1e8dc47
commit b29602f1a1
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -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.
6. **Środowisko Docker**: Całość działa w odseparowanych kontenerach (web, db) uruchamianych jednym poleceniem, z automatycznymi migracjami i początkowym seedowaniem bazy.