This project is a terminal user interface (TUI) application built with the Bubble Tea framework. It fetches and displays GitHub contribution data for a specified user.
- Fetch GitHub contribution data using the GitHub GraphQL API.
- Display contribution data in a grid format.
- Simple and intuitive TUI for user interaction.
- Go (version 1.16 or later)
- A GitHub personal access token with the necessary permissions to access the GitHub GraphQL API.
-
Clone the repository:
git clone https://github.com/jvanrhyn/github-contributions-tui.git cd github-contributions-tui
-
Create a
.env
file in the root directory of the project and add your GitHub token:echo "GITHUB_TOKEN=your_github_token" > .env
-
Install the dependencies:
go mod tidy
-
Run the application:
go run main.go
-
Enter the GitHub username when prompted and press
Enter
. -
The application will fetch and display the contribution data for the specified user.
-
To quit the application, press
Ctrl+C
oresc
.
main.go
: The main entry point of the application..env
: Environment file containing the GitHub token.go.mod
: Go module file specifying the dependencies.go.sum
: Go module file containing the cryptographic hashes of the dependencies.
- Bubble Tea: A powerful, elegant, and simple TUI framework for Go.
- godotenv: A Go port of Ruby's dotenv library (loads environment variables from
.env
).
This project is licensed under the MIT License. See the LICENSE file for details.
- Charmbracelet for the Bubble Tea framework.
- Joho for the godotenv library.