Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.87 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.87 KB

GitGlyph

Netlify Status GitHub stars Last Commit Pull Requests License

GitGlyph

GitGlyph is a tool to track issues in any GitHub repository with a specific label. It sends notifications whenever a new issue with the specified label is detected.

Features

  • Track issues in any GitHub repository by specifying the repository and label.
  • Notifications are sent to a specified email address (e.g., via SMTP).
  • Easy setup with environment variables.

Getting Started

Prerequisites

  • Go (1.20 or later)
  • A GitHub Personal Access Token with repo and read:org permissions.
  • An SMTP server (e.g., Gmail) for notifications (optional).

Setup Instructions

  1. Fork this Repository

    • Click the "Fork" button at the top-right of this page to create your own copy of this repository. OR

  2. Clone the Repository

    git clone https://github.com/<your-username>/GitGlyph.git
cd GitGlyph

  3. Configure Environment Variables

    Copy the .env.example file to .env:

    cp .env.example .env

    Edit the .env file with your preferred values:

    GITHUB_TOKEN=your_personal_access_token
TARGET_REPO_OWNER=target_repo_owner
TARGET_REPO_NAME=target_repo_name
LABEL_TO_TRACK=label_to_track
[email protected]

  4. Run the Application

    go run main.go