Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |