Giter Club home page Giter Club logo

go-kick's Introduction

Kick

Go Report Card

A lightweight mechanism to provide an instant kickstart to a Go web server instance, upon the modification of a Go source file within a particular project directory (including any subdirectories).

An instant kickstart consists of a recompilation of the Go code and a restart of the web server instance.

Kick comes with the ability to take both the go and gopherjs commands into consideration when performing the instant kickstart.

Supported Operating Systems

Kick works on Windows and Unix-like operating systems (e.g., BSD, Linux, Mac OS).

Installation

Before installing Kick, it is recommended, to install the barebones isogoapp first โ€“ since it will provide you with an example of how to use kick.

Get Kick

go get -u go.isomorphicgo.org/go/kick

Usage

Getting Help

Issue the help flag to get help on using the kick command:

kick --help

Running Kick

Example (using GopherJS):

kick --appPath=$ISOGO_APP_ROOT --mainSourceFile=isogoapp.go --gopherjsAppPath=$ISOGO_APP_ROOT/client

The appPath flag specifies the project directory where the Go application resides.

The mainSourceFile flag specifies the Go source file that implements the main function.

The gopherjsAppPath flag specifies the directory to the GopherJS client-side application. This flag is optional.

If your Go project is not using GopherJS, you can feel free to omit the gopherjsAppPath flag.

Verify That Kick Is Functioning

Assuming that you've installed the isogoapp, and you have issued the kick command to run the web server instance:

Access the test page for the isogoapp using your web browser.

Open up the client.go source file in the $ISOGO_APP_ROOT/client directory. Change the message that is passed to the SetInnerHTML() function call.

Refresh your web browser. You should see your change reflected.

In the command line prompt where you issued the kick command, take note of the "Recompiling and Restarting" message. This is kick's way of telling you that an instant kickstart was performed.

The Isomorphic Go Project

More information on the benefits of Isomorphic Go applications can be found at the Isomorphic Go Website.

License

Kick is licensed under the BSD License. Read the LICENSE file for more information.

go-kick's People

Contributors

engineerkamesh avatar arunsworld avatar jro7 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.