https://github.com/KyleBanks/goggles
🔠Goggles is a cross-platform GUI for your $GOPATH!
https://github.com/KyleBanks/goggles
go-tools golang golang-tools gopath gui
Last synced: about 1 month ago
JSON representation
🔠Goggles is a cross-platform GUI for your $GOPATH!
- Host: GitHub
- URL: https://github.com/KyleBanks/goggles
- Owner: KyleBanks
- License: apache-2.0
- Created: 2017-03-18T13:44:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-29T19:13:24.000Z (over 7 years ago)
- Last Synced: 2024-12-06T19:09:55.580Z (4 months ago)
- Topics: go-tools, golang, golang-tools, gopath, gui
- Language: Go
- Homepage:
- Size: 5.4 MB
- Stars: 671
- Watchers: 16
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-discoveries - goggles - a GUI for your $GOPATH _(`Go`)_ (Dev Tools with GUI)
- awesome - goggles - 🔠Goggles is a cross-platform GUI for your $GOPATH! (Go)
README
# goggles
[](https://godoc.org/github.com/KyleBanks/goggles)Â
[](https://travis-ci.org/KyleBanks/goggles)Â
[](https://goreportcard.com/report/github.com/KyleBanks/goggles)Â
[](https://coveralls.io/github/KyleBanks/goggles?branch=master)
🔠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](https://github.com/KyleBanks/goggles/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](https://www.npmjs.com/) and [Gulp](http://gulpjs.com/), in order to build the front-end assets.
3. Install [go-bindata-assetfs](https://github.com/elazarl/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](https://github.com/alexflint/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](https://github.com/alexflint/gallium) project.
## Author
Goggles was developed by [Kyle Banks](https://twitter.com/kylewbanks).
## Thanks
The [Gopher](./static/img) loading images were created by [Ashley McNamara](https://twitter.com/ashleymcnamara) and inspired by [Renee French](http://reneefrench.blogspot.co.uk/).
## License
Goggles is available under the [Apache 2.0](./LICENSE) license.