https://github.com/calvinmclean/stocker

Easily get on-demand information about fish stocking in Arizona
https://github.com/calvinmclean/stocker

Last synced: about 2 months ago
JSON representation

Easily get on-demand information about fish stocking in Arizona

• Host: GitHub
• URL: https://github.com/calvinmclean/stocker
• Owner: calvinmclean
• License: apache-2.0
• Created: 2024-11-03T00:16:22.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-03T00:34:06.000Z (about 2 months ago)
• Last Synced: 2024-11-03T01:18:44.266Z (about 2 months ago)
• Language: Go
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stocker

[![GitHub go.mod Go version (subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/calvinmclean/stocker?filename=go.mod)](https://github.com/calvinmclean/stocker/blob/main/go.mod)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/calvinmclean/stocker/main.yml?branch=main)

[![License](https://img.shields.io/github/license/calvinmclean/stocker)](https://github.com/calvinmclean/stocker/blob/main/LICENSE)

[![Go Reference](https://pkg.go.dev/badge/github.com/calvinmclean/stocker.svg)](https://pkg.go.dev/github.com/calvinmclean/stocker)

Stocker leverages data from [AZ GFD's Stocking Schedule](https://www.azgfd.com/fishing-2/where-to-fish/fish-stocking-schedule/) to provide on-demand information about fish stocking in Arizona.

Check it out at https://azstocker.com!

## How To

Install using `go install` or cloning this repository:

```shell

go install github.com/calvinmclean/stocker/cmd/stocker@latest

```

### Get API Key

First, a Google API key is necessary to access the stocking schedule Google Sheet.

Follow [these instructions](https://developers.google.com/sheets/api/quickstart/go) from Google to setup a developer account, then get an API key instead of the Oauth credentials file.

Set the API key as the `API_KEY` environment variable or supply as a CLI flag with `--api-key`

### Run CLI

```shell

# get the last and next Winter stocking dates for the Lower Salt River and Rose Canyon Lake

stocker get -p winter -w "lower salt river" -w "rose canyon lake" --next --last

```

### Run Server

```shell

# run the server

stocker server

# use curl to get the last and next stocking dates for all CFP waters

curl 'localhost:8080/cfp?next=true&last=true&showAll=true'

```