https://github.com/joostvdg/cmg

Small CLI (or web) tool for generating fair and balanced Catan board layouts
https://github.com/joostvdg/cmg

boardgame catan catan-board-game

Last synced: 25 days ago
JSON representation

Small CLI (or web) tool for generating fair and balanced Catan board layouts

• Host: GitHub
• URL: https://github.com/joostvdg/cmg
• Owner: joostvdg
• License: mit
• Created: 2019-01-30T22:29:42.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T03:25:32.000Z (over 1 year ago)
• Last Synced: 2024-06-19T20:51:42.645Z (5 months ago)
• Topics: boardgame, catan, catan-board-game
• Language: Go
• Homepage: http://catan-ui.herokuapp.com
• Size: 4.56 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Catan Map Generator (CMG)

App for generating Catan maps which are fair and balanced.

## Badges

[![license](https://img.shields.io/github/license/joostvdg/cmg.svg)]()

[![GitHub release](https://img.shields.io/github/release/joostvdg/cmg.svg)]()

[![GitHub Action](https://github.com/joostvdg/cmg/workflows/Go%20Build/badge.svg)]()

[![Heroku](http://heroku-badge.herokuapp.com/?app=catan-map-generator&svg=1)]()

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0f9aa8d2206648ae863fd934c4fc5095)](https://app.codacy.com/app/joostvdg/cmg?utm_source=github.com&utm_medium=referral&utm_content=joostvdg/cmg&utm_campaign=Badge_Grade_Dashboard)

[![Go Report Card](https://goreportcard.com/badge/joostvdg/cmg)](https://goreportcard.com/report/github.com/joostvdg/cmg)

![gopherbadger-tag-do-not-edit](https://img.shields.io/badge/Go%20Coverage-62%25-brightgreen.svg?longCache=true)

[![DepShield Badge](https://depshield.sonatype.org/badges/joostvdg/cmg/depshield.svg)](https://depshield.github.io)

## Live version

The application is running as a free heroku app to try: [https://catan-map-generator.herokuapp.com/api/map](https://catan-map-generator.herokuapp.com/api/map).

Look for the Code to see the API for for more commands (or the shell scripts such as `6p-game.sh`).

The UI is available at [https://catan-ui.herokuapp.com//](https://catan-ui.herokuapp.com/).

## Run as Google Cloud Function

See the wrapper project [github.com/joostvdg/cmg-gcf](https://github.com/joostvdg/cmg-gcf) for running it as a Cloud Function.

## Run on Heroku

* get Heroku CLI: `brew tap heroku/brew && brew install heroku` 

    * linux `sudo snap install --classic heroku`

    * [download installer](https://cli-assets.heroku.com/heroku-x64.exe) for windows

* create app with Heroku: `heroku create`

* configure go.mod file (see below)

* publish to Heroku app: `git push heroku master`

### Go.mod

When using Go 1.11+, just use `gomod` for managing deps, don't use the others tools unless you have a good reason.

When using `gomod`, you have to add some annotations for Heroku to your `go.mod` file.

Docs state it defaults to building `.`, it seemed it was `./cmd/.` which was not correct for me.

Probably best to state it explicitly.

```bash

// +heroku goVersion go1.11

// +heroku install .

```

For more info, [read Heroku's docs on Go](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-go).