https://github.com/hellerve/hi

A dead simple chat
https://github.com/hellerve/hi

chat minimal

Last synced: 17 days ago
JSON representation

A dead simple chat

• Host: GitHub
• URL: https://github.com/hellerve/hi
• Owner: hellerve
• Created: 2017-03-03T19:06:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-09T15:28:11.000Z (over 7 years ago)
• Last Synced: 2024-10-10T18:25:06.702Z (about 1 month ago)
• Topics: chat, minimal
• Language: Go
• Size: 10.7 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hi

A dead simple chat server and client without any external dependencies.

The UI is inspired by material design, but comes without framework bloat.

The entire page is about 19kb in size, without any minification.

The server is written in Go and pretty fast. Also, it's dead-simple.

There are probably bugs.

## Channels

Channels are weird. Anyone can send messages to any channel. A channel

exists as long as there is someone in that channel. If there isn't, the

channel will be closed. What "being in a channel" means is basically

that you subscribe to it, i.e. you will receive messages posted in that

channel. It doesn't affect the way you post there, though. Channels

are conversations. You can scream something at a group of people, or

choose to join that group and interact with them.

## Security

Nothing is stored in a database. Everything is kept in memory, there

is no history. That means that all knowledge and all communication is

ephemeral, like at a party where you join and leave conversations as

you please. Please use HTTPS when deploying this chat, preferably through

nginx or any other web server.

## Deployment

This is where it gets tricky. If you know how to (cross-)compile Go programs

and put them on your server and run it, deploying `hi` is as simple as compiling,

e.g. with `GOOS= go build`, and copying the resulting binary

and the public directory to a server, then letting it run. Letting it run could

be more or less involved, depending on your hosting provider. I'll be glad to help.

## Running

The compiled program can be run without arguments (runs on port 8080) or with

the port set (using the `-p` option). It assumes that the public directory is in

the directory where the program is started.

## Commands

There are a few special commands that you can issue to interact with the server,

IRC-style. All of these commands need to be sent to a channel that the user subscribes

to.

```

/join   # join a channel

/leave  # leave a channel (will send back an error if user is not subscribed to the channel)

/list                # list all users in the current channel

/channels            # list all channels

```



Have fun!