Minke generator to create a REST API microservice with Golang
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib/generators
spec
.gitignore
.rspec
.ruby-gemset
.ruby-version
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Gemfile
LICENSE.txt
README.md
Rakefile
minke-generator-go.gemspec

README.md

Minke

Minke::Generators::GoMicroservice

Build Status
Stories in Ready

This generator creates a REST API Microservice in Go for the Minke build and test system.

For information on Minke please see the documentation http://nicholasjackson.github.io/minke/.

Available variables for templates (erb style)

Variable Description
<%= application_name %> The name of the application executable
<%= namespace %> Namespace of the application
<%= src_root %> Source root of the application

Generate a new service

$ mkdir service
$ cd service
$ curl -L -s get.minke.rocks | bash -s ' -g minke-generator-go -o $(pwd) -n nicholasjackson/service -a service'

NOTE: replace nicholasjackson/service with your github user and application name this needs to correspond to the input namespace you would use in your go code.

You do not need to create this folder inside your GOPATH as all builds are run localised in a Docker container however for an effective workflow. It is very beneficial to follow the standard go conventions.

The generator uses GO vendoring and all sub packages will be cached in the vendor folder.

Build and test with Docker

To run a build with a Docker container, to execute the functional and unit tests you can use the following commands. Please see the main Minke documentation for more information http://nicholasjackson.github.io/minke/.

Build Application Code and Execute Unit tests

$ cd _build
$ ./minke.sh rake app:test

Build a Docker image and execute functional tests with Cucumber

$ ./minke.sh rake app:build_image
$ ./minke.sh rake app:cucumber

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nicholasjackson/minke-generator-netmvc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).