https://github.com/dimaskiddo/codebase-go-cli
Codebase for Command-Line Interface (CLI) Application in Go
https://github.com/dimaskiddo/codebase-go-cli
cli codebase command-line go golang interface
Last synced: 10 months ago
JSON representation
Codebase for Command-Line Interface (CLI) Application in Go
- Host: GitHub
- URL: https://github.com/dimaskiddo/codebase-go-cli
- Owner: dimaskiddo
- Created: 2019-01-04T03:17:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T05:11:31.000Z (over 2 years ago)
- Last Synced: 2025-01-06T20:36:37.252Z (12 months ago)
- Topics: cli, codebase, command-line, go, golang, interface
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codebase for Command-Line Interface (CLI) Application in Go
This codebase help a new Go developer in developing a Command-Line Interface (CLI) Application using Go.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Prequisites packages:
* Go (Go Programming Language)
* Dep (Go Dependencies Management Tool)
* Make (Automated Execution using Makefile)
Optional packages:
* GoReleaser (Go Automated Binaries Build)
### Installing
Below is the instructions to make this codebase running:
* Create a Go Workspace directory and export it as the extended GOPATH directory
```
cd
export GOPATH=$GOPATH:"`pwd`"
```
* Under the Go Workspace directory create a source directory
```
mkdir -p src///
```
* Move to the created directory and pull codebase
```
cd src///
git clone -b master https://github.com/dimaskiddo/codebase-go-cli.git .
```
* Run following command to change the codebase repository URL to your own
```
make rebase REBASE_URL="//"
```
* Run following command to renew and pull dependecies package
```
make init
make vendor
```
* Until this step you already can run this code by using this command
```
make run
```
## Running The Tests
Currently the test is not ready yet :)
## Deployment
**Make sure your your go script does not relate to github.com/dimaskiddo/codebase-go-cli anymore**.
To build this codebase to binaries for distribution purposes you can run following command:
```
make release
```
The build result will shown in build directory
## Built With
* [Go](https://golang.org/) - Go Programming Languange
* [Dep](https://github.com/golang/dep) - Go Dependency Management Tool
* [GoReleaser](https://github.com/goreleaser/goreleaser) - Go Automated Binaries Build
* [Make](https://www.gnu.org/software/make/) - GNU Make Automated Execution
## Authors
* **Dimas Restu Hidayanto** - *Initial Work* - [DimasKiddo](https://github.com/dimaskiddo)
See also the list of [contributors](https://github.com/dimaskiddo/codebase-go-cli/contributors) who participated in this project
## Annotation
You can seek more information for the make command parameters in the [Makefile](https://raw.githubusercontent.com/dimaskiddo/codebase-go-cli/master/Makefile)