retro

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

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

Go to latest
Published: Jan 28, 2018 License: MIT Imports: 8 Imported by: 0

README

retro

A webapp for running (remote) retrospectives.

Install

You will need NodeJS and Go installed, then you should be able to

$ go get hawx.me/code/retro
$ cd $GOPATH/src/hawx.me/code/retro
$ make install

Configuration

Retro reads configuration from a config.toml file, so create one.

To authenticate by GitHub against a particular organisation you will need to setup an application with the "Authorization callback URL" of http://localhost:8080/oauth/github/callback (substitute the place you will host retro for http://localhost:8080). Then add the following to your config.toml.

[github]
clientID = "..."
clientSecret = "..."
organisation = "..."

To authenticate by Office365 against a particular domain you will need to setup an application with the "Redirect URLs" of http://localhost:8080/oauth/office365/callback (substitute the place you will host retro for http://localhost:8080). Then add the following to your config.toml.

[office365]
clientID = "..."
clientSecret = "..."
domain = "..."

Build and test

Build and test with make,

$ make
$ make test

The build step puts everything in ./out, so you can run retro from that folder too

$ cd out
$ retro

This will run the app at http://localhost:8080 by default (this can be changed by passing --port or using --socket).

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package sock handles the connection of websocket client connections and the sending of messages to them.
Package sock handles the connection of websocket client connections and the sending of messages to them.

Jump to

Keyboard shortcuts

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