Update readme lib list

This commit is contained in:
Ken-Håvard Lieng 2018-11-10 12:56:31 +01:00
parent 474afda9c2
commit 48f59604a6
1 changed files with 24 additions and 7 deletions

View File

@ -5,36 +5,43 @@
![Dispatch](https://khlieng.com/dispatch.png?1)
### Features
* Searchable history
* Persistent connections
* Multiple servers and users
* Automatic HTTPS through Let's Encrypt
* Client certificates
- Searchable history
- Persistent connections
- Multiple servers and users
- Automatic HTTPS through Let's Encrypt
- Client certificates
## Usage
There is a few different ways of getting it:
### 1. Binary
- **[Windows (x64)](https://github.com/khlieng/dispatch/releases/download/v0.4/dispatch_windows_amd64.zip)**
- **[OS X (x64)](https://github.com/khlieng/dispatch/releases/download/v0.4/dispatch_darwin_amd64.zip)**
- **[Linux (x64)](https://github.com/khlieng/dispatch/releases/download/v0.4/dispatch_linux_amd64.tar.gz)**
- [Other versions](https://github.com/khlieng/dispatch/releases)
### 2. Go
This requires a [Go environment](http://golang.org/doc/install), version 1.10 or greater.
Fetch, compile and run dispatch:
```bash
go get github.com/khlieng/dispatch
dispatch
```
To get some help run:
```bash
dispatch help
```
### 3. Docker
```bash
docker run -p <http port>:80 -p <https port>:443 -v <path>:/data khlieng/dispatch
```
@ -42,15 +49,18 @@ docker run -p <http port>:80 -p <https port>:443 -v <path>:/data khlieng/dispatc
## Build
### Server
```bash
cd $GOPATH/src/github.com/khlieng/dispatch
go install
```
### Client
This requires [Node.js](https://nodejs.org) and [yarn](https://yarnpkg.com).
Fetch the dependencies:
```bash
go get github.com/jteeuwen/go-bindata/...
yarn global add gulp@next
@ -59,6 +69,7 @@ yarn
```
Run the build:
```bash
gulp build
```
@ -66,18 +77,23 @@ gulp build
The server needs to be rebuilt to embed new client builds.
For development with hot reloading start the frontend:
```bash
gulp
```
and the backend in a separate terminal:
And then the backend in a separate terminal:
```bash
dispatch --dev
```
## Libraries
The libraries this project is built with.
### Server
- [Bolt](https://github.com/boltdb/bolt)
- [Bleve](https://github.com/blevesearch/bleve)
- [Cobra](https://github.com/spf13/cobra)
@ -85,10 +101,11 @@ The libraries this project is built with.
- [Lego](https://github.com/xenolf/lego)
### Client
- [React](https://github.com/facebook/react)
- [Redux](https://github.com/reactjs/redux)
- [Immer](https://github.com/mweststrate/immer)
- [React Virtualized](https://github.com/bvaughn/react-virtualized)
- [react-window](https://github.com/bvaughn/react-window)
- [Lodash](https://github.com/lodash/lodash)
## Big Thanks