goggles

README

goggles

     

🔭 Goggles is a GUI for your $GOPATH.

Features

• Browse and search local packages
• View package documentation
• Open the project folder in Finder or Terminal
• Open the project repository in your browser
• Displays badges for GoDoc, Goreportcard, and Travis.CI (if .travis.yml is present)

Install

Goggles can be run in a web browser (cross-platform) or as a standalone application (Mac only).

Stable (browser & standalone)

Grab the latest release from the Releases page.

From Source (browser mode)

Requires go 1.8 or higher.

$ go get github.com/KyleBanks/goggles/cmd/goggles
$ goggles

Contributing

Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it.

In order to work on Goggles there are a few steps you'll need to take in order to build and run from source:

1. go get github.com/KyleBanks/goggles/...
2. Install npm and Gulp, in order to build the front-end assets.
3. Install go-bindata-assetfs in order to bundle front-end assets into the Go binary.

Web Browser

1. Run make to build and run Goggles in your web browser.

Standalone (Mac Only)

1. Install Gallium, in order to bundle the .app.
2. Run make app to build and launch the application.

Note: If you'd like to see Goggles available as a standalone application on additional platforms, I encourage you to help contribute to the Gallium project.

Author

Goggles was developed by Kyle Banks.

Thanks

The Gopher loading images were created by Ashley McNamara and inspired by Renee French.

License

Goggles is available under the Apache 2.0 license.