An open API service indexing awesome lists of open source software.

https://github.com/bretfisher/probable-octo-adventure


https://github.com/bretfisher/probable-octo-adventure

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Your first GitHub Action

A sample repo that you can copy with the template button. It'll build and test a basic Go app.

A simple CLI fortune cookie application that displays random inspirational quotes. Built with Go and Cobra, this project serves as a template for the simplest GitHub Actions and demonstrates basic CLI application development.

## Project Description

This application provides random error messages from software over the years. Run it to receive your error fortune!

The project is built using:
- **Go** - The main programming language
- **Cobra** - A powerful CLI library for Go
- **GitHub Actions** - For CI/CD automation

## Installation

### Prerequisites
- Go 1.24.4 or later
- Git

### Install from Source

1. Clone the repository:
```bash
git clone https://github.com/bretfisher/first-action.git
cd first-action
```

2. Build the application:
```bash
go build -o eball
```

3. (Optional) Install globally:
```bash
go install
```

### Install using Go Install

```bash
go install github.com/bretfisher/first-action@latest
```

## Usage Examples

### Basic Usage

Run the application to get a random fortune:

```bash
./eball
```

Output example:
```
🥠 Your Fortune:
It was always DNS.
```

### Command Line Options

View help information:
```bash
./eball --help
```

## Development

### Project Structure

```
first-action/
├── cmd/
│ └── root.go # Main command logic and fortune definitions
├── main.go # Application entry point
├── go.mod # Go module definition
├── go.sum # Go module checksums
├── LICENSE # Project license
└── README.md # This file
```

### Building

```bash
go build -o eball
```

### Testing

```bash
go test ./...
```

## License

This project is licensed under the terms specified in the LICENSE file.