https://github.com/athlon1600/chat
💬 Chat application written in TypeScript with a Vue frontend
https://github.com/athlon1600/chat
chat chat-application chat-sdk chatroom express javascript live livestream realtime-chat redis self-hosted socket-io typescript vue websocket
Last synced: 5 months ago
JSON representation
💬 Chat application written in TypeScript with a Vue frontend
- Host: GitHub
- URL: https://github.com/athlon1600/chat
- Owner: Athlon1600
- License: mit
- Created: 2022-12-30T15:40:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T17:05:01.000Z (about 3 years ago)
- Last Synced: 2025-07-19T17:15:28.065Z (6 months ago)
- Topics: chat, chat-application, chat-sdk, chatroom, express, javascript, live, livestream, realtime-chat, redis, self-hosted, socket-io, typescript, vue, websocket
- Language: TypeScript
- Homepage: https://chat-athlon1600.netlify.app/lofi.html
- Size: 193 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chat Application
Highly customizable chat server/application that is easy to deploy, and can be integrated with any sort of website.
Host your own **chat server** on your own terms.
May be used by Twitch streamers who want to host their own chat server
away from Twitch infrastructure and moderation.
## Live demo
- https://chat-athlon1600.netlify.app/
Playground for developers showing things you can do using HTTP/Websocket API.
- https://chat-athlon1600.netlify.app/lofi.html
A more real-world example showing chat embedded alongside a live stream.
## :warning: Work in progress...
This project is still in its beta stage. Nothing is guaranteed until v1.0.0.
## 🔥 Features
- First-class TypeScript support - IDE should be doing half the work for you
- Single repository (why monorepo? https://monorepo.tools/)
- :whale: Dockerized
- Not tied to any particular infrastructure or service - we are in a world where AWS, Firebase and Twitch do not exist
- Infinitely scalable with minimal changes
- Minimal dependencies
## Repository Structure
Entire application is **self-contained** within this single repository
which has many advantages during development.
- `/apps` folder contains "launchable" apps that can be started by calling `npm run start` within that application's directory. Neither application can depend on another. Apps can only depend on `packages`.
- `/packages` folder contains "shared" code used by apps and by other packages too.
## :whale2: Local Development using Docker
Two things you need installed first:
- Node.js (>=16) - https://nodejs.org/
- Docker - https://www.docker.com/products/docker-desktop/
Now run these commands:
```shell
git clone https://github.com/Athlon1600/chat
cd chat
npm run docker:dev
```
This will take a while, but once up and running
you will be able to access the following services
on your local computer:
- localhost:8080 = frontend
- localhost:3000 = server/backend
- localhost:9000 = adminer (for browsing/editing db contents)
- localhost:8001 = Redis Insight
## :rocket: One-click install
Rent a server from Linode or such (preferably of Ubuntu variety),
and paste the following command into your terminal:
```
curl -s https://raw.githubusercontent.com/Athlon1600/chat/master/scripts/install.sh | bash
```
Everything will be installed all at once without needing any further input from you.
If install was a success, you can then access the application via the IP address that was assigned to your server. See
the demo links above of what that would look like.
### Caddy Server
One-click install:
```shell
curl -sS https://raw.githubusercontent.com/Athlon1600/chat/master/scripts/caddy.sh | sh
```
Once Caddy is installed, you need to modify these files:
- `.env.production` - rename to `.env` and change values inside
- `docker-compose-prod.yml` - adjust values there accordingly too
- `etc/Caddyfile`
```shell
caddy run --config ./etc/Caddyfile
```
## :construction: To-do list
- Build a proper `/admin` backend instead of doing management directly via database (adminer).
- https://typedoc.org/
- https://palantir.github.io/tslint/usage/cli/