Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/inadarei/justgo

Skeleton for jump-starting a Go-powered microservice project with Docker and Go best-practices + easy code hot-reloading (for dev environments)!
https://github.com/inadarei/justgo

apis docker generator go golang microservices scaffolding templates

Last synced: 2 months ago
JSON representation

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

Awesome Lists containing this project

README

        

# Jump-Start Go (JustGo)
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/inadarei/justgo/issues)
[![Go project version](https://badge.fury.io/go/github.com%2Finadarei%2Fjustgo.svg)](https://badge.fury.io/go/github.com%2Finadarei%2Fjustgo)
[![Go Report Card](https://goreportcard.com/badge/github.com/inadarei/justgo)](https://goreportcard.com/report/github.com/inadarei/justgo-microservice)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Finadarei%2Fjustgo.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Finadarei%2Fjustgo?ref=badge_shield)

A helpful builder for a light-weight Go [skeleton project](https://github.com/inadarei/justgo-microservice) 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](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](https://github.com/golang/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](https://github.com/inadarei/justgo-microservice#quickstart)

## Upgrade with Brew

```BASH
> 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](https://github.com/apiaryio/api-blueprint-rfcs/blob/master/template.md). Before contributing, please read the [code of conduct](https://github.com/inadarei/justgo/blob/master/CODE_OF_CONDUCT.md).

See [Contributing](CONTRIBUTING.md).

## License

[MIT](LICENSE)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Finadarei%2Fjustgo.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Finadarei%2Fjustgo?ref=badge_large)