Skip to content

A TypeScript CLI application for tracking and categorizing completed GitHub tickets.

Notifications You must be signed in to change notification settings

daltonmcphaden/github-issues-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Issues Tracker

A TypeScript CLI application for tracking completed GitHub tickets.

Features

  • Fetches closed GitHub issues assigned to you since Jan 1 2023.
  • Interactive CLI interface to categorize each issue as "backend", "frontend", "devops", etc.
  • Provides a summary of how many of each type of ticket you've completed.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/github-issues.git
  2. Navigate to the project directory:

    cd github-issues-tracker
  3. Install the dependencies:

    npm install
  4. Create a .env file in the root of your project and add your GitHub personal access token and organization name:

    GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN
    GITHUB_ORGANIZATION_NAME=YOUR_GITHUB_ORGANIZATION_NAME
    

Usage

  1. To start the CLI application:
npm run dev
  1. Follow the on-screen prompts to categorize your closed issues. You can stop at any point and your progress will be saved.

Dependencies

  • axios for making HTTP requests.
  • dotenv for loading environment variables.
  • inquirer for interactive CLI interface.
  • lowdb for lightweight local database.

Contributing

Feel free to submit pull requests.

About

A TypeScript CLI application for tracking and categorizing completed GitHub tickets.

Topics

Resources

Stars

Watchers

Forks