dispatch/README.md

60 lines
1014 B
Markdown
Raw Normal View History

2015-03-04 17:41:25 +00:00
# name_pending
Web-based IRC client in Go.
2015-05-29 00:55:28 +00:00
## Features
* Searchable history
* Persistent connections
* Multiple users
## Usage
There is a few different ways of getting it.
### 1. Binary
There will be binary releases.
### 2. Go
This requires a [Go environment](http://golang.org/doc/install).
2015-03-04 17:41:25 +00:00
```bash
go get github.com/khlieng/name_pending
2015-05-29 00:55:28 +00:00
name_pending
2015-03-04 17:41:25 +00:00
```
2015-05-29 00:55:28 +00:00
To get some help run:
```bash
2015-05-29 00:55:28 +00:00
name_pending help
```
2015-05-29 00:55:28 +00:00
### 3. Docker
```bash
docker run -p 8080:8080 khlieng/name_pending
```
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
cd $GOPATH/src/github.com/khlieng/name_pending
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/...
cd $GOPATH/src/github.com/khlieng/name_pending/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
will turn off minification and embedding, requiring only one initial server rebuild.