https://github.com/bastean/bingo
Example service for generating custom cross-compile executable binaries
https://github.com/bastean/bingo
bingo fomantic-ui go templ
Last synced: 9 months ago
JSON representation
Example service for generating custom cross-compile executable binaries
- Host: GitHub
- URL: https://github.com/bastean/bingo
- Owner: bastean
- License: mit
- Created: 2024-04-08T22:25:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T03:03:53.000Z (about 2 years ago)
- Last Synced: 2025-01-16T08:34:36.811Z (over 1 year ago)
- Topics: bingo, fomantic-ui, go, templ
- Language: Go
- Homepage:
- Size: 510 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/bastean/bingo)
> Example service for generating custom cross-compile executable binaries
[](LICENSE)
[](https://goreportcard.com/report/github.com/bastean/bingo)
[](https://github.com/commitizen/cz-cli)
[](https://github.com/release-it/release-it)
[](https://github.com/bastean/bingo/actions/workflows/upgrade.yml)
[](https://github.com/bastean/bingo/actions/workflows/ci.yml)
[](https://github.com/bastean/bingo/actions/workflows/release.yml)
[](https://pkg.go.dev/github.com/bastean/bingo)
[](https://github.com/bastean/bingo/releases)
## Usage
```bash
make demo
```
### Screenshots
### Binary
```bash
chmod +x bingo
```
```bash
./bingo --help
```
```text
Example service for generating custom cross-compile executable binaries
Usage:
bingo [flags]
bingo [command]
Available Commands:
animal Generate random animal information
completion Generate the autocompletion script for the specified shell
help Help about any command
internet Generate random internet information
language Generate random language information
payment Generate random payment information
person Generate random person information
Flags:
-h, --help help for bingo
Use "bingo [command] --help" for more information about a command.
```
```bash
./bingo person --help
```
```text
Generate random person information
Usage:
bingo person [flags]
Flags:
--email Generate random email
-h, --help help for person
--phone Generate random phone
```
## First Steps
### Clone
#### HTTPS
```bash
git clone https://github.com/bastean/bingo.git && cd bingo
```
#### SSH
```bash
git clone git@github.com:bastean/bingo.git && cd bingo
```
### Initialize
#### Dev Container (recommended)
1. Install required
- [Docker](https://docs.docker.com/get-docker)
- [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
2. Start VS Code
```bash
code .
```
3. Open Command Palette
- Ctrl+Shift+P
4. Run
```txt
Dev Containers: Reopen in Container
```
#### Locally
1. Install required
- [Go](https://go.dev/doc/install)
- [Node](https://nodejs.org/en/download)
- [Make](https://www.gnu.org/software/make)
- [Docker](https://docs.docker.com/get-docker)
2. Run
```bash
make init
```
#### ZIP
1. [Install required](#locally)
2. Run
```bash
make init-from-zero
```
### Run
#### ENVs
> [!IMPORTANT]
> Before running it, you must set the following environment variables and rename the file to **.env.(dev|test|prod)**
>
> - [.env.example](deployments/.env.example)
> [!TIP]
> You can check the demo file to see which values you can use
>
> - [.env.example.demo](deployments/.env.example.demo)
#### Development
```bash
make compose-dev
```
#### Test
- Unit
```bash
make test-unit
```
- Integration
```bash
make test-integration
```
- Acceptance
```bash
make compose-test-acceptance
```
- All
```bash
make compose-test-all
```
#### Production
```bash
make compose-prod
```
## Tech Stack
#### Base
- [Go](https://go.dev)
- [templ](https://templ.guide)
- [Fomantic-UI](https://fomantic-ui.com)
#### Please see
- [go.mod](go.mod)
- [package.json](package.json)
## Contributing
- Contributions and Feedback are always welcome!
## License
- [MIT](LICENSE)