theghinzou / wcg

formation

word-cloud-generator

It's a golang web app that takes a block of text and turns it into a word cloud. insertion wb

Notice

This project is under active development. This project is being created as a sample app for an upcoming training class on Continuous Delivery with Lynda.com. You can see previous courses we have made at https://lynda.com/JamesWickett. Thanks!

Prerequisites

1. Install go - https://golang.org/doc/install (Start learning go with the tour - http://tour.golang.org/)
2. Set $GOPATH export GOPATH="${HOME}/go"
3. Set $PATH export PATH=$PATH:$(go env GOPATH)/bin
4. Install godep - go get github.com/tools/godep
5. Install goconvey - go get github.com/smartystreets/goconvey
6. Install rice - go get github.com/GeertJohan/go.rice/rice

Git

We use git hooks to standardize development on the project. Please run make git-hooks to get started.

Using Make

Building Artifacts

This will pull down dependencies, run unit tests, and compile a linux, mac and windows binary into ./artifacts.

make

Fiddling Around

You can build and install a copy in your local $GOPATH/bin directory with:

make install

Clean up previous build files

make clean

Test Coverage

make test

Visual Test Coverage

make goconvey

Bundle HTML and JS

make rice

To Run

make run or just run the executable. It will run as a daemon and bind to port 8888, and you can see it by going to http://localhost:8888 in your browser.

Use API via Curl

$ curl -H "Content-Type: application/json" -d '{"text":"ths is a really really really important thing this is"}' http://localhost:8888/api