chat

module

v0.0.0-...-e1bcdf1 Latest Latest Go to latest Published: Feb 14, 2019 License: BSD-2-Clause

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/milla-v/chat

README ¶

Chat server project

Quick help

Get: go get github.com/milla-v/chat/...
Doc: godoc -http=:6060 ; firefox http://localhost:6060/pkg/chat/

Goals and features

Extremely simple deployment of private chat server.
Secure over https.
Cross platform.
Web client, console client, API for any client.
Instant server upgrade using ocean tool.

Get and build chatd, chatc, ocean

go get github.com/milla-v/chat/...

Read documentation

Run document server

godoc -http=:6060

Open documentation

firefox http://localhost:6060/pkg/chat/

Run server

chatd

Open web client

firefox https://localhost:8085

Deploy to the cloud

ocean -def

Run console client

chatc

Useful aliases

alias gg='go install github.com/milla-v/chat/...'
alias nn='terminal-notifier -remove chatc'
alias gf='git format-patch origin/master'

gg -- install chat
nn -- hide chat notification on OSX
gf -- format patch

Directories ¶

Path	Synopsis
auth Package auth implements user registration and authentication for chat project.	Package auth implements user registration and authentication for chat project.
client Package client implements simple console chat client.	Package client implements simple console chat client.
cmd
chat chat command runs a chat server.	chat command runs a chat server.
chatc chatc command runs a simple console chat client.	chatc command runs a simple console chat client.
chatembed chatembed command generates embedded_files.go file from files directory.	chatembed command generates embedded_files.go file from files directory.
config Package config implements chat service config.	Package config implements chat service config.
prot Package prot provides protocol structures for communication between chat server and client.	Package prot provides protocol structures for communication between chat server and client.
service Package service implements chat http service.	Package service implements chat http service.
util

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