Code Monkey home page Code Monkey logo

github-contributions-tui's Introduction

GitHub Contributions TUI

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.

Features

  • Fetch GitHub contribution data using the GitHub GraphQL API.
  • Display contribution data in a grid format.
  • Simple and intuitive TUI for user interaction.

Prerequisites

  • Go (version 1.16 or later)
  • A GitHub personal access token with the necessary permissions to access the GitHub GraphQL API.

Installation

  1. Clone the repository:

    git clone https://github.com/jvanrhyn/github-contributions-tui.git
    cd github-contributions-tui
  2. Create a .env file in the root directory of the project and add your GitHub token:

    echo "GITHUB_TOKEN=your_github_token" > .env
  3. Install the dependencies:

    go mod tidy

Usage

  1. Run the application:

    go run main.go
  2. Enter the GitHub username when prompted and press Enter.

  3. The application will fetch and display the contribution data for the specified user.

  4. To quit the application, press Ctrl+C or esc.

Project Structure

  • 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.

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).

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

github-contributions-tui's People

Contributors

jvanrhyn avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.