|
| 1 | +# 🌍 Global Chat Server |
| 2 | + |
| 3 | +A lightweight real-time chat backend built with **FastAPI** and **WebSockets**. |
| 4 | + |
| 5 | +This repository contains the **server implementation** for Global Chat. |
| 6 | +The desktop client is distributed separately via GitHub Releases. |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +# 📥 Download Desktop Application |
| 11 | + |
| 12 | +You can download the Windows desktop chat client here: |
| 13 | + |
| 14 | +## ⬇ Download Installer |
| 15 | + |
| 16 | +[](https://github.com/TutorialsAndroid/global-chat/releases/download/v1.0.0/GlobalChatInstaller.exe) |
| 17 | + |
| 18 | +Download the latest version and run the installer to start chatting. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +# ✨ Features |
| 23 | + |
| 24 | +- 🌍 Real-time global chat |
| 25 | +- ⚡ WebSocket communication |
| 26 | +- 💬 Multi-user messaging |
| 27 | +- 🔗 Clickable links in chat |
| 28 | +- 📋 Selectable and copyable messages |
| 29 | +- 🪟 Minimal floating chat window |
| 30 | +- 📌 Always-on-top interface |
| 31 | +- ⚙ Settings menu with startup option |
| 32 | +- 📜 Chat history loading |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +# 🏗 Server Technology |
| 37 | + |
| 38 | +The backend server uses: |
| 39 | + |
| 40 | +- **FastAPI** |
| 41 | +- **WebSockets** |
| 42 | +- **Uvicorn** |
| 43 | + |
| 44 | +It broadcasts messages to all connected clients in real time. |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +# 🚀 Deployment |
| 49 | + |
| 50 | +This server is designed to be deployed on platforms such as: |
| 51 | + |
| 52 | +- Railway |
| 53 | +- Render |
| 54 | +- Fly.io |
| 55 | +- VPS servers |
| 56 | + |
| 57 | +Example Railway deployment command: |
| 58 | + |
| 59 | +``` |
| 60 | +uvicorn server:app --host 0.0.0.0 --port 8000 |
| 61 | +``` |
| 62 | +--- |
| 63 | +# 🔌 WebSocket Endpoint |
| 64 | +``` |
| 65 | +/chat |
| 66 | +
|
| 67 | +``` |
| 68 | +Example connection URL: |
| 69 | +wss://your-server-url/chat |
| 70 | +``` |
| 71 | +--- |
| 72 | +
|
| 73 | +# 📦 Installation (Server) |
| 74 | +
|
| 75 | +Install dependencies: |
| 76 | +
|
| 77 | +``` |
| 78 | +pip install -r requirements.txt |
| 79 | + |
| 80 | +``` |
| 81 | +Run the server: python server.py |
| 82 | +``` |
| 83 | + |
| 84 | +--- |
| 85 | + |
| 86 | +# ⚠ Notes |
| 87 | + |
| 88 | +- Message history may reset after server redeploy if SQLite is used. |
| 89 | +- Production deployments should use PostgreSQL or Redis. |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +# 📜 License |
| 94 | + |
| 95 | +MIT License |
0 commit comments