inadarei / justgo

Skeleton for jump-starting a Go-powered microservice project with Docker and Go best-practices + easy code hot-reloading (for dev environments)!

Jump-Start Go (JustGo)

A helpful builder for a light-weight Go skeleton project takes care of a lot of boilerplate in jump-starting a Go-powered microservice development with Docker and Go best-practices.

To learn more: https://justgo.rocks

Features:

1. Isolated, project-specific Go environments in a container. No cross-project dependency issues.
2. No mess with configuring GOPATH across projects!
3. Code hot-reloading out of the box!
4. Ready to ship as a container in production, when you are done working with it.
5. Future-proof choice of dep for dependency-management

INSTALLATION

Easiest way to create a new project skeleton is to install JustGo CLI tool. There's no necessity to install Go on your machine, since the setup provides fully functioning Go environment in a Docker container.

If you already have Go on your machine, you can install the CLI tool with:

> go get github.com/inadarei/justgo

Please make sure you have $GOPATH environment variable set and that $GOPATH/bin is in your $PATH.

or you can install it using Homebrew, even if you don't have Go:

> brew tap inadarei/casks
> brew install justgo

USAGE

After you have installed the CLI tool, to create a skeleton of a new project, just run:

> justgo

You can see various options by running justgo -h. To learn how to run a project, once it is created, see here

Upgrade with Brew

> brew update
> brew upgrade justgo

Contributing

Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an RFC. Before contributing, please read the code of conduct.

See Contributing.

License

MIT

justgo's Issues

Ignore non-problematic files in the destination folder

Currently Justgo requires the destination folder to be completely empty. This can be annoying if you are working in a freshly created github workspace which will typically have .git, .gitignore and README.md.

JustGo should consider presence of these three items to be equivalent of folder being empty, in order to provide better user-experience during bootstrapping.

Setup failure on windows

Summary / Context

A new install on windows fails to unpack the justgo.zip file.

Expected Behavior

A new install to be able to create the skeleton directory.

Current Behavior

PS D:\workdir\go\src\github.com\inadarei\justgo> .\justgo.exe test-app-master
Building a skeleton microservice at destination path: `test-app-master`
open C:\Tempjustgo.zip: Access is denied.

Steps

I'm using a windows 10 machine, with $GOPATH on a different drive than the os.TempDir() returns, though I do not think this has any bearing on the problem.

1. Perform the steps in installation instructions
2. run justgo.exe myApp

Suggestions for Solution

Add a path separator on the download location (patch coming soon).

Replace glide with godep as the dependency manager

Summary / Context

Godep has officially become public and deemed safe for production as the standard Go dependency tool.
As such, Gophers are encouraged to migrate their existing projects over to Godep. Sam Boyer and the rest of the Godep team has made it very easy to do so:

during dep init configuration from other dependency managers is detected and imported, unless -skip-tools is specified.

Current Behavior

Currently, justgo is using Glide as its dependency manager, which presents many issues and pain points.

Suggestion for a Solution

It would be best to migrate sooner rather than later, since we want to be able to build out the project without concern for dependency management any longer.