From c6dc29510067c03b5bea3bf43d6c5666820165f5 Mon Sep 17 00:00:00 2001 From: Brian Buller Date: Mon, 24 Jul 2017 08:54:02 -0500 Subject: [PATCH 1/5] Filled out readme file --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++---- assets.go | 2 +- 2 files changed, 78 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index aa4b490..b7c3397 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,83 @@ # ictgj-voting The ICT GameJam Voting Application -pass in the `-dev` flag to enable development mode (load assets from file system instead of embedded). +Downloading and Running +---- +Download a binary from the list below that is appropriate for your system +Run the binary, if a database is not found in the current directory, the application will walk you through +and initial set up (create an admin user, give the site a title, name the current game jam) and a database +will be created in the current directory -Uses 'esc' for embedding assets: -https://github.com/mjibson/esc -TODO: Build Instructions +Command Line Arguments +---- + +Configuration arguments +Passing a configuration argument will save the value to the database for future use +```bash + -title= Set the title for the site + -port=<port> The port to run the site on + -session-name=<name> A name to use for the session + -server-dir=<director> Directory to use for assets (templates/js/css) + -reset-defaults Reset all of the configurable site settings to their defaults + This only affects the settings that can be set from the command line +``` + +Runtime Arguments +These arguments only affect the current run of the application +```bash + -help Display the application help, breakdown of arguments + -dev Run in development mode, load assets (templates/js/css) from file system + rather than the binary +``` + +Prebuilt Binaries +---- +[Linux 64 bit](https://br0xen.com/dowload/ictgj-voting/gjvote.linux64 "Linux 64 bit build") + +[Linux 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.linux386 "Linux 32 bit build") + +[Linux Arm](https://br0xen.com/download/ictgj-voting/gjvote.linuxarm "Linux Arm build") + +[Mac OS](https://br0xen.com/download/ictgj-voting/gjvote.darwin64 "Mac OS build") + +[Windows 64 bit](https://br0xen.com/download/ictgj-voting/gjvote.win64 "Windows 64 bit build") + +[Windows 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.win386 "Windows 32 bit build") + + +Building +---- +```bash +go get github.com/devict/ictgj-voting +``` + + +Developing/Contributing Notes +---- +Do not make changes to `assets.go`, this file is generated when you run `go generate` + +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 + +Please use the go tooling to match the standard go coding style. For parts that aren't bound by that style, +either try to match the already existing style, or give a reason why you think it should change. + + +Vendorings +---- +* 'boltdb' as a data store: https://github.com/boltdb/bolt +* 'boltease' to manipulate the bolt db easier: https://github.com/br0xen/boltease +* Various 'gorilla' libraries for http server stuff: https://github.com/gorilla/ + * context: https://github.com/gorilla/context + * handlers: https://github.com/gorilla/handlers + * mux: https://github.com/gorilla/mux + * securecookie: https://github.com/gorilla/securecookie + * sessions: https://github.com/gorilla/sessions +* 'alice' for http server middleware: https://github.com/justinas/alice +* 'uuid' for uuid generation: https://github.com/pborman/uuid +* 'esc' for embedding assets: https://github.com/mjibson/esc + -TODO: Contribution Instructions diff --git a/assets.go b/assets.go index 3468421..60d7fbf 100644 --- a/assets.go +++ b/assets.go @@ -12040,7 +12040,7 @@ Xo6z3V9nVvnKh0MZ+h0AAP//kX1qvCYDAAA= "/templates/admin-main.html": { local: "templates/admin-main.html", size: 1476, - modtime: 1500477139, + modtime: 1500477228, compressed: ` H4sIAAAJbogA/6xTTQ/aMAy971d4FRKXtQHtNrWVEJN22oc2tp1Da0q0NGFJWoQQ/30OAVTxMVDhgpPY fjy/56alaKGQ3NosKrRyqFyUvwHw7z7Safk+/9bMpSjgsy4xZXQPiXnjnFagVUHJP1m0FqrU60Tqgjuh From 22ab9045d858a19f30a2b572a8b14f7eda48d8aa Mon Sep 17 00:00:00 2001 From: Brian Buller <brian@bullercodeworks.com> Date: Mon, 24 Jul 2017 08:57:07 -0500 Subject: [PATCH 2/5] Readme Work --- README.md | 65 +++++++++++++++++++++++++------------------------------ 1 file changed, 29 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b7c3397..53dc3bd 100644 --- a/README.md +++ b/README.md @@ -3,47 +3,42 @@ The ICT GameJam Voting Application Downloading and Running ---- -Download a binary from the list below that is appropriate for your system -Run the binary, if a database is not found in the current directory, the application will walk you through -and initial set up (create an admin user, give the site a title, name the current game jam) and a database -will be created in the current directory +Download a binary from the list below that is appropriate for your system +Run the binary, if a database is not found in the current directory, the application will walk you through +and initial set up (create an admin user, give the site a title, name the current game jam) and a database +will be created in the current directory Command Line Arguments ---- -Configuration arguments -Passing a configuration argument will save the value to the database for future use +Configuration arguments +Passing a configuration argument will save the value to the database for future use ```bash - -title=<title> Set the title for the site - -port=<port> The port to run the site on - -session-name=<name> A name to use for the session - -server-dir=<director> Directory to use for assets (templates/js/css) - -reset-defaults Reset all of the configurable site settings to their defaults - This only affects the settings that can be set from the command line + -title=<title> Set the title for the site + -port=<port> The port to run the site on + -session-name=<name> A name to use for the session + -server-dir=<director> Directory to use for assets (templates/js/css) + -reset-defaults Reset all of the configurable site settings to their defaults + This only affects the settings that can be set from the command line ``` -Runtime Arguments -These arguments only affect the current run of the application +Runtime Arguments +These arguments only affect the current run of the application ```bash - -help Display the application help, breakdown of arguments - -dev Run in development mode, load assets (templates/js/css) from file system - rather than the binary + -help Display the application help, breakdown of arguments + -dev Run in development mode, load assets (templates/js/css) from file system + rather than the binary ``` Prebuilt Binaries ---- -[Linux 64 bit](https://br0xen.com/dowload/ictgj-voting/gjvote.linux64 "Linux 64 bit build") - -[Linux 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.linux386 "Linux 32 bit build") - -[Linux Arm](https://br0xen.com/download/ictgj-voting/gjvote.linuxarm "Linux Arm build") - -[Mac OS](https://br0xen.com/download/ictgj-voting/gjvote.darwin64 "Mac OS build") - -[Windows 64 bit](https://br0xen.com/download/ictgj-voting/gjvote.win64 "Windows 64 bit build") - -[Windows 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.win386 "Windows 32 bit build") +[Linux 64 bit](https://br0xen.com/dowload/ictgj-voting/gjvote.linux64 "Linux 64 bit build") +[Linux 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.linux386 "Linux 32 bit build") +[Linux Arm](https://br0xen.com/download/ictgj-voting/gjvote.linuxarm "Linux Arm build") +[Mac OS](https://br0xen.com/download/ictgj-voting/gjvote.darwin64 "Mac OS build") +[Windows 64 bit](https://br0xen.com/download/ictgj-voting/gjvote.win64 "Windows 64 bit build") +[Windows 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.win386 "Windows 32 bit build") Building @@ -55,15 +50,13 @@ go get github.com/devict/ictgj-voting Developing/Contributing Notes ---- -Do not make changes to `assets.go`, this file is generated when you run `go generate` +Do not make changes to `assets.go`, this file is generated when you run `go generate` +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 -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 - -Please use the go tooling to match the standard go coding style. For parts that aren't bound by that style, -either try to match the already existing style, or give a reason why you think it should change. +Please use the go tooling to match the standard go coding style. For parts that aren't bound by that style, +either try to match the already existing style, or give a reason why you think it should change. Vendorings From 89c6939f8800e633ec7b9584eca82089e4d040ec Mon Sep 17 00:00:00 2001 From: Brian Buller <brian@bullercodeworks.com> Date: Mon, 24 Jul 2017 08:58:31 -0500 Subject: [PATCH 3/5] Readme Work --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 53dc3bd..3f1618d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Command Line Arguments Configuration arguments Passing a configuration argument will save the value to the database for future use -```bash +``` -title=<title> Set the title for the site -port=<port> The port to run the site on -session-name=<name> A name to use for the session @@ -25,7 +25,7 @@ Passing a configuration argument will save the value to the database for future Runtime Arguments These arguments only affect the current run of the application -```bash +``` -help Display the application help, breakdown of arguments -dev Run in development mode, load assets (templates/js/css) from file system rather than the binary @@ -43,7 +43,7 @@ Prebuilt Binaries Building ---- -```bash +``` go get github.com/devict/ictgj-voting ``` From f757abcf5d88c8f983fa12968ed19b2b5bbd11f4 Mon Sep 17 00:00:00 2001 From: Brian Buller <brian@bullercodeworks.com> Date: Mon, 24 Jul 2017 09:01:44 -0500 Subject: [PATCH 4/5] Readme Work --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f1618d..1ba7c8c 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Command Line Arguments Configuration arguments Passing a configuration argument will save the value to the database for future use -``` +```none -title=<title> Set the title for the site -port=<port> The port to run the site on -session-name=<name> A name to use for the session @@ -25,7 +25,7 @@ Passing a configuration argument will save the value to the database for future Runtime Arguments These arguments only affect the current run of the application -``` +```none -help Display the application help, breakdown of arguments -dev Run in development mode, load assets (templates/js/css) from file system rather than the binary From 660917ca02a1adbc137c35ac1ee85ad3e3c78f10 Mon Sep 17 00:00:00 2001 From: Brian Buller <brian@bullercodeworks.com> Date: Mon, 24 Jul 2017 09:02:10 -0500 Subject: [PATCH 5/5] Readme Work --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ba7c8c..212142c 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Prebuilt Binaries Building ---- -``` +```none go get github.com/devict/ictgj-voting ```