https://github.com/deild/myapp

Golang cli application, based on
https://github.com/deild/myapp

cli go goreleaser mage

Last synced: 4 months ago
JSON representation

Golang cli application, based on

• Host: GitHub
• URL: https://github.com/deild/myapp
• Owner: deild
• License: mit
• Created: 2018-05-14T21:07:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-23T19:08:57.000Z (about 8 years ago)
• Last Synced: 2025-12-18T04:49:34.623Z (7 months ago)
• Topics: cli, go, goreleaser, mage
• Language: Go
• Homepage: https://carlosbecker.com/posts/golang-cli-apps/
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Myapp

[![GitHub Release](https://img.shields.io/github/release/deild/myapp.svg)](https://github.com/deild/myapp/releases/latest)

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/deild/myapp)

[![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-blue.svg)](https://github.com/goreleaser)

[![SemVer](https://img.shields.io/badge/semver-2.0.0-blue.svg)](https://semver.org/)

## Overview

Myapp is an myapp app.

## Folder structure

A basic tree would look like:

    .

    ├── commands

    │   ├── myapp.go

    │   └── myapp_test.go

    ├── script

    │   └── setup

    ├── .gitignore

    ├── .travis.yml

    ├── CONTRIBUTING.md

    ├── Gopkg.lock

    ├── Gopkg.toml

    ├── LICENSE

    ├── README.md

    ├── goreleaser.yml

    ├── magefile.go

    └── main.go

- commands/myapp.go and myapp_test.go: is the “library” of the application and its respective files. Could be more than one file, of course;

- script: script help me start new projects faster;

- .gitignore: some standard gitignore, vendor, binary, etc;

- .travis.yml: tell Travis CI what to do;

- CONTRIBUTING.md: newcommer guide;

- Gopkg.lock and Gopkg.toml: dependencies locks and manifest;

- README.md: what you are reading;

- LICENSE: MIT;

- goreleaser.yml: the GoReleaser configuration;

- magefile.go: contains common tasks for the project, like formating, testing, linting, etc;

- main.go: is the cli entrypoint;

## Starting a new project

To use it, you can simply:

```bash

cd $GOPATH/src/github.com/youruser

git clone git@github.com/deild/myapp.git yourapp

cd myapp

./script/setup youruser YourApp # notice the case on the second arg

```

It is actually a working app (that does nothing), to run it:

```bash

mage vendor

go run main.go -h

```

Now, you create a [GitHub repository](https://help.github.com/articles/create-a-repo/) for your new app and push it:

```bash

git remote add origin https://github.com/youruser/yourapp.git

git push origin master

```

If you check the README file, you’ll see that there are already a few badges on the bottom, but some of them are not working. Let’s fix them!

## Contributing to Myapp

First of all, you can read the [CONTRIBUTING.md](CONTRIBUTING.md) file. It is the _“newcomer guide”_.

## Health

[![Travis](https://img.shields.io/travis/deild/myapp.svg)](https://travis-ci.org/deild/myapp)

[![CodeFactor](https://www.codefactor.io/repository/github/deild/myapp/badge)](https://www.codefactor.io/repository/github/deild/myapp)

[![Coverage Status](https://coveralls.io/repos/github/deild/myapp/badge.svg?branch=master)](https://coveralls.io/github/deild/myapp?branch=master)

[![codecov](https://codecov.io/gh/deild/myapp/branch/master/graph/badge.svg)](https://codecov.io/gh/deild/myapp)

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