go-vue-websockets

README

go-vue-websockets

A Golang HTTP server / Vue.js web application that establishes a Websocket connection to echo.websocket.org

The frontend utilizes Vue.js Components and the entire application can be easily shipped as a binary or container thanks to Go + Docker 🐋

Can serve as an example project for starting other Vue + Go apps

Directory structure

├── go-vue-websockets
│   ├── ui - Vue.js frontend directory
│   └── statik - Embedded static frontend files directory
├── main.go - Main server entrypoint
├── server.go - HTTP Server logic
├── Makefile - Build helper
├── Dockerfile - Container build spec

Build info and requirements

A Makefile is included for common build tasks.
Built using Go 1.12 and Vue CLI 3

Build tools used:

• Vue CLI
• NPM
• Golang 1.1+
• Statik
• Make utility
• Docker

List of URL routes

URL Path	Request Type	Purpose
/	GET	Main frontend
/log-collector	POST	Collects user entered input from the frontend
/metrics	GET	Prometheus style metrics endpoint
/health	GET	Returns a 200 HTTP code while app is running
/ready	GET	Returns a 200 HTTP code when app is ready to serve traffic

Building with Docker

1. Clone and enter this repo:

$ git clone git@github.com:cvasq/go-vue-websockets.git

1. Build the docker image (Container size: ~12MB)

$ make container

1. Run the built container image and map the application listening port to your localhost. Default port: 8080

$ docker run -p 8080:8080 cvasquez/vue-websocket-echo:latest  

Output:
2019/07/24 18:02:40 Server starting on port 8080... 
2019/07/24 18:02:40 Web Interface: http://localhost:8080/
2019/07/24 18:02:40 Prometheus Metrics: http://localhost:8080/metrics
2019/07/24 18:02:40 Liveness Endpoint: http://localhost:8080/health
2019/07/24 18:02:40 Readiness Endpoint: http://localhost:8080/ready

Building from source

1. Clone and enter this repo:

$ git clone git@github.com:cvasq/go-vue-websockets.git

1. Build the Vue.JS frontend along with Go Binary

$ make build

1. Run the new executable binary file

$ ./go-vue-websockets 

Output:

2019/07/24 18:02:06 Server starting on port 8080...
2019/07/24 18:02:06 Web Interface: http://localhost:8080/
2019/07/24 18:02:06 Prometheus Metrics: http://localhost:8080/metrics
2019/07/24 18:02:06 Liveness Endpoint: http://localhost:8080/health
2019/07/24 18:02:06 Readiness Endpoint: http://localhost:8080/ready

CLI Help Message

$ ./go-vue-websockets -h

NAME:
   go-vue-websockets - Vue.js Websocket Client Example

USAGE:
   go-vue-websockets [global options] command [command options] [arguments...]

VERSION:
   1.0.0

AUTHOR:
   Carlos Vasquez <carlos@email.com>

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --listening-port value  Listening Port (default: "8080") [$LISTENING_PORT]
   --help, -h              show help
   --version, -v           print the version