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

View File

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