Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgaunet/template-cli
https://github.com/sgaunet/template-cli
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sgaunet/template-cli
- Owner: sgaunet
- License: mit
- Created: 2023-10-15T18:25:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-18T15:22:18.000Z (7 months ago)
- Last Synced: 2024-05-18T16:30:31.998Z (7 months ago)
- Language: Go
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# template-cli
template-cli is a template project to build a cli with Go.
Clone it with:
```bash
# install gonew
go install golang.org/x/tools/cmd/gonew@latest
# use gonew to create your project based on this template
gonew github.com/sgaunet/template-cli gitplatform.com/username/awesome_new_project
cd awesome_new_project
git init
git add .
git remote add origin [email protected]:username/awesome_new_project
git push -u origin master
```
# Getting started
Usage is quite simple :
```
$ ./template-cli -h
...
```
# Install
## From binary
Download the binary in the release section.
## From Docker image
Docker registry is:
## Deployment with docker-example
!TODO
## Deployment iwth kubernetes manifests
!TODO
## Deployment with helm
!TODO
# Development
This project is using :
* golang
* [task for development](https://taskfile.dev/#/)
* docker
* [docker buildx](https://github.com/docker/buildx)
* docker manifest
* [goreleaser](https://goreleaser.com/)
* [venom](https://github.com/ovh/venom) : Tests
* [pre-commit](https://pre-commit.com/)
There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:
```
brew install pre-commit
```
Install tools:
```
task dev:install-prereq
```
And install the hooks:
```
task dev:install-pre-commit
```
If you like to launch manually the pre-commmit hook:
```
task dev:pre-commit
```
# Tests
Tests are done with [venom](https://github.com/ovh/venom).
```
cd tests
venom run
```