/comet

A dashboard that helps you compare branches and tags for any GitHub repository

Primary LanguageTypeScriptOtherNOASSERTION

Comet

Build Docker build

This is a dashboard to easily compare branches and tags for any GitHub repository.

Setup

  • Make sure Docker is running on your computer.
  • Generate a GitHub API token. Make sure to give it the repo permission, which is required to navigate through your repositories.
  • Run the following command to start the dashboard: 
    docker run -it -p 3080:80 -e GITHUB_TOKEN=....... airtasker/comet
  • Navigate to http://localhost:3080 to see the dashboard.

Jira integration

If you'd like to automatically see the status of associated Jira tickets, you'll need to pass a few additional environment variables through Docker:

  • JIRA_HOST, for example if you use Jira Cloud https://yourproject.atlassian.net.
  • JIRA_EMAIL, which is your Jira account.
  • JIRA_API_TOKEN, see official instructions.

Development

In order to run Comet in development mode (via yarn start), you will need to have the following environment variables set:

export REACT_APP_GITHUB_TOKEN=...

# If you would like to enable Jira integration too.
export REACT_APP_JIRA_HOST=...
export REACT_APP_JIRA_EMAIL=...
export REACT_APP_JIRA_TOKEN=...