anon-chat-app

command module
v0.0.0-...-5b4f9c9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2024 License: MIT Imports: 5 Imported by: 0

README ΒΆ

πŸš€ anon-chat-app πŸ—¨οΈ

Welcome to the Anonymous Chat App! πŸŽ‰

This project is a real-time chat platform where users can join anonymously and communicate with others via WebSockets.

No usernames, no trackingβ€”just a simple, fun, and anonymous way to chat! πŸ’¬

cover

Features ✨

  • Real-time Messaging: Instantly chat using WebSockets. ⚑
  • Anonymous Chat: No sign-up neededβ€”just join and start chatting! 🎭
  • Message History: Access all previous messages upon connecting. πŸ”„
  • Quick Sending: Use the send button or Ctrl + Enter for fast message delivery. πŸš€
  • Message Counter: Check total messages sent via the /count endpoint. πŸ“Š
  • Data Persistence: Chat history is saved in a file and reloaded on server start. πŸ“

Endpoints πŸ“¬

Endpoint Description
/ Home page
/live WebSocket endpoint
/count Total message count

Quick Start πŸš€

Docker run 🐳
docker run --rm -p 8080:8080 -d --name anon-chat-app dekuyo/anon-chat-app:latest

Then, navigate to http://localhost:8080 in your browser to start chatting!

For persistent data storage, you can mount a volume to the container:

touch data.json
docker run --rm -p 8080:8080 -v $(pwd)/data.json:/app/data.json -d --name anon-chat-app dekuyo/anon-chat-app:latest
Running Locally 🏠

(1) Clone the repository:

git clone github.com/escalopa/anon-chat-app

(2) Navigate to the project directory:

cd anon-chat-app

(3) Create storage file:

touch data.json

(4) Run the server:

docker compose up

OR using go

go run main.go

Technologies πŸ’»

GO | HTML | CSS | JavaScript | WebSockets | Docker

Contributing 🀝

Feel free to submit issues, suggestions, or pull requests! Every contribution is welcome. πŸš€

Future Improvements πŸ› οΈ

  • Add HTTPS support for secure connections.
  • Add metrics with prometheus & grafana.

License πŸ“œ

This project is licensed under the MIT License.


Enjoy your anonymous chat experience! πŸ˜ŽπŸŽ‰


Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL