https://github.com/br34th7aking/pingo
Real-time chat application built with React, Django Channels, Redis, and PostgreSQL. Features WebSocket communication, multiple chat rooms, and modern containerized deployment.
https://github.com/br34th7aking/pingo
chat-application django django-channels django-rest-framework docker postgresql react real-time redis websocket
Last synced: 2 months ago
JSON representation
Real-time chat application built with React, Django Channels, Redis, and PostgreSQL. Features WebSocket communication, multiple chat rooms, and modern containerized deployment.
- Host: GitHub
- URL: https://github.com/br34th7aking/pingo
- Owner: Br34th7aking
- Created: 2025-08-16T11:20:00.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-16T16:59:14.000Z (10 months ago)
- Last Synced: 2025-08-16T17:23:18.179Z (10 months ago)
- Topics: chat-application, django, django-channels, django-rest-framework, docker, postgresql, react, real-time, redis, websocket
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pingo - Real-time Chat Platform
Discord-like chat application with servers, channels, and real-time messaging.
## Current Status
🚧 **Phase 1 Development** - Building core MVP features
### Completed Issues
- ✅ **Issue #1**: Backend Setup (Django + Channels + DRF + Docker)
- ✅ **Issue #2**: Authentication System (Custom User + JWT + GitHub Actions CI)
- ✅ **Issue #3**: Server Models & Membership Management API
- 🔄 **Issue #4**: Channel Models & Messaging (Next)
## Features (Completed)
- [x] Project setup with Docker
- [x] User authentication - JWT based auth system
- [x] CI pipeline using Github Actions
- [x] Server management - Create, join, and manage Discord-like servers
- [x] Membership system - Role-based access control (owner/admin/moderator/member)
- [x] Public/Private servers with invite codes
- [ ] Channel creation and management
- [ ] Real-time messaging
- [ ] Direct messaging
## Documentation
### API Documentation
- [Authentication](./docs/authentication.md) - Complete authentication API reference
- [Servers & Membership](./docs/servers.md) - Server management and member operations
## Quick Start
```bash
# Clone repository
git clone https://github.com/your-username/pingo.git
cd pingo
# Start development environment
docker-compose up -d
# Run tests
docker-compose exec backend python manage.py test
## API Endpoints
#### Base URL: http://127.0.0.1:8000/api/
#### Authentication: /auth/
Registration, login, profile management
JWT token-based authentication
See Authentication Docs for details
#### Servers & Membership: /servers/
Server CRUD operations with role-based permissions
Member management (join, leave, promote, remove)
Public/private servers with invite codes
See Server Docs for complete reference
## Tech Stack
Backend: Django 4.x, Django REST Framework, Channels
Database: PostgreSQL, Redis
Authentication: JWT tokens
CI/CD: GitHub Actions
Containerization: Docker & Docker Compose
```