dispatch/README.md

62 lines
1.1 KiB
Markdown
Raw Normal View History

2015-12-11 03:35:48 +00:00
# dispatch [![Build Status](https://travis-ci.org/khlieng/dispatch.svg?branch=master)](https://travis-ci.org/khlieng/dispatch)
2015-03-04 17:41:25 +00:00
2015-12-11 03:41:53 +00:00
####[Try it!](http://dispatch.khlieng.com/)
2015-06-04 22:04:34 +00:00
### Features
2015-05-29 00:55:28 +00:00
* Searchable history
* Persistent connections
* Multiple users
## Usage
2015-06-04 22:04:34 +00:00
There is a few different ways of getting it:
2015-05-29 00:55:28 +00:00
2015-06-04 22:04:34 +00:00
#### 1. Binary
2015-05-29 00:55:28 +00:00
There will be binary releases.
2015-06-04 22:04:34 +00:00
#### 2. Go
2015-05-29 00:55:28 +00:00
This requires a [Go environment](http://golang.org/doc/install).
2015-03-04 17:41:25 +00:00
```bash
2015-12-11 03:35:48 +00:00
go get github.com/khlieng/dispatch
2015-05-29 00:55:28 +00:00
2015-12-11 03:35:48 +00:00
dispatch
2015-03-04 17:41:25 +00:00
```
2015-05-29 00:55:28 +00:00
To get some help run:
```bash
2015-12-11 03:35:48 +00:00
dispatch help
```
2015-06-04 22:04:34 +00:00
#### 3. Docker
2015-05-29 00:55:28 +00:00
```bash
2015-12-11 03:35:48 +00:00
docker run -p 8080:8080 khlieng/dispatch
2015-05-29 00:55:28 +00:00
```
2015-05-29 00:55:28 +00:00
## Build
2015-05-29 00:55:28 +00:00
### Server
2015-03-04 17:41:25 +00:00
```bash
2015-12-11 03:35:48 +00:00
cd $GOPATH/src/github.com/khlieng/dispatch
go install
2015-03-04 17:41:25 +00:00
```
2015-05-29 00:55:28 +00:00
### Client
This requires [Node.js](https://nodejs.org/download/).
2015-05-29 00:55:28 +00:00
Fetch the dependencies:
2015-03-04 17:41:25 +00:00
```bash
npm install -g gulp
go get github.com/jteeuwen/go-bindata/...
2015-12-11 03:35:48 +00:00
cd $GOPATH/src/github.com/khlieng/dispatch/client
2015-03-04 17:41:25 +00:00
npm install
2015-05-29 00:55:28 +00:00
```
2015-05-29 00:55:28 +00:00
Run the build:
```bash
2015-03-04 17:41:25 +00:00
gulp -p
2015-05-29 00:55:28 +00:00
```
2015-05-29 00:55:28 +00:00
The server needs to be rebuilt after this. For development dropping the -p flag
2015-06-04 22:04:34 +00:00
will turn off minification and embedding, requiring only one initial server rebuild.