Skip to content
Permalink
Browse files

Updating readme

  • Loading branch information...
Depado committed Jan 22, 2016
1 parent 7e23a0c commit 913f830a049d967afbf53da65d6b7b97219bfb8a
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
@@ -1,2 +1,30 @@
# govue
An attempt to work with Vue.js and a golang gin rest server

## Quickstart

If you want to give `govue` a try :
```
go get github.com/Depado/govue
cd $GOPATH/src/Depado/govue
npm install
echo "port: 8080
debug: true
api_version: 1" > conf.yml
go build
./govue
```

## Configuration

The current configuration file is `conf.yml` at the root of the project. Here is an example configuration file :

```
port: 8080
debug: true
api_version: 1
```

**port :** The port on which the server should run
**debug :** Tells gin to run in debug mode or not
**api_version :** An integer representing the API version. The only API verison for now is `1`

0 comments on commit 913f830

Please sign in to comment.
You can’t perform that action at this time.