https://github.com/spoorloos/ws_chat
Simple end to end encrypted chatroom website.
https://github.com/spoorloos/ws_chat
bun chatroom end-to-end-encryption http-server nodejs websocket
Last synced: 4 months ago
JSON representation
Simple end to end encrypted chatroom website.
- Host: GitHub
- URL: https://github.com/spoorloos/ws_chat
- Owner: Spoorloos
- Created: 2024-08-15T19:56:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T19:59:36.000Z (over 1 year ago)
- Last Synced: 2025-04-06T13:45:35.480Z (about 1 year ago)
- Topics: bun, chatroom, end-to-end-encryption, http-server, nodejs, websocket
- Language: TypeScript
- Homepage:
- Size: 160 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Websocket Chatrooms
This is a simple websocket chatroom website I built using Bun and websockets during my time off from school to learn more about end to end encryption and just as a way to entertain myself.
Login Page | Chat Page
--- | ---
 | 
## Features
- **End-to-End Encryption**: Messages are encrypted before being sent and can only be decrypted by the recipients.
- **Real-Time Communication**: Using websockets for real time messaging.
- **Simple UI**: A (very) minimal and easy-to-use interface.
## Setup
### Prerequisites
- Make sure you have [bun](https://bun.sh/) installed of course.
### Getting Started
1. Clone the repository.
2. Place your SSL certificates in the [certs/](certs/) folder if you have any. (The website will not function properly over HTTP)
3. Change the passphrase and file names of your certificates in [.env](.env) if needed.
4. Run the following commands inside a terminal in the folder:
```bash
bun install
```
```
bun run dev|build|start
```
## Contributions
Contributions are again very much welcome! Please fork the repository and create a pull request for any changes you'd like to make.