brian/ictgj-voting
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

clarify steps for setting up development environment, added comments

Browse Source
This commit is contained in:
hitjim 2017-10-31 22:56:17 -05:00
parent 3eea9e32af
commit a470de0647
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -45,7 +45,16 @@ go get github.com/devict/ictgj-voting
``` ```
## Developing/Contributing Notes ## Developing/Contributing
### Setup
1. Fork this repo, rather than cloning directly.
1. Run `go get github.com/mjibson/esc`
1. Then `go get` your github fork, similarly to the command in the Building section above.
1. Run `go generate`
1. Run `go build`
1. Make and commit your changes, then submit a Pull Request (PR) through GitHub from your fork to `github.com/devict/ictgj-voting`
### Notes
* Pass in the `-dev` flag to enable development mode (load assets from the file system instead of embedded). * Pass in the `-dev` flag to enable development mode (load assets from the file system instead of embedded).
* After making changes to assets (templates, javascript, css) be sure to run `go generate` before `go build` - this regenerates the `assets.go` file * After making changes to assets (templates, javascript, css) be sure to run `go generate` before `go build` - this regenerates the `assets.go` file
* Please use the go tooling to match the standard go coding style. * Please use the go tooling to match the standard go coding style.

3
main.go
View File

@ -20,7 +20,10 @@ import (
"github.com/justinas/alice" "github.com/justinas/alice"
) )
// AppName Application name
const AppName = "gjvote" const AppName = "gjvote"
// DbName Database name, which is <AppName>.db
const DbName = AppName + ".db" const DbName = AppName + ".db"
// pageData is stuff that changes per request // pageData is stuff that changes per request