Skip to content

This is a Chrome extension intended to interface with clubwpt.com. It offers the ability to modify the timezone for tournaments, and save specified tournaments to a users Google Calendar for easy reminders.

License

Notifications You must be signed in to change notification settings

jcook3701/ClubPoker

Repository files navigation

ClubPoker Chrome Extension

Overview

This is a Chrome extension intended to interface with clubwpt.com. It offers the ability to modify timezone for tournaments viewed on lobby.clubwpt.com site. And save specified tournaments to a users Google Calendar for easy reminders.

Unofficial helper tool for ClubWPT's website. Not affiliated with WPT in any way. This Chrome extension scrapes tournament information from the ClubWPT lobby website modifies live tournament times for user specified timezone and allows the ability to add tournaments to a specified Google Calendar. No longer will you miss the large daily tournaments.

Source Code Installation

  1. Open Google Chrome and navigate to chrome://extensions/.
  2. Enable "Developer mode".
  3. Clone or download this repository.
  4. Build package from source code. This allows for code to run within google chrome.
$ npm run build  
  1. Click "Load unpacked" and select the directory containing this project.

Usage

  1. Navigate to the ClubWPT lobby website.
  2. Click on the extension icon to open the popup.
  3. Click the "Scrape Tournaments" button.
  4. The tournament information will be scraped and added to your Google Calendar.

Development

Pre-commit commands

  1. Auto fix linting errors and improve code quality.
$ npm run lint-fix  
  1. Auto fix code formatting to improve readability and my sanity.
$ npm run pretty  

Documentation

Documentation is able to be update automatically via typedoc and scripts/inject-front-matter.js.

  1. Run the following command to update documentation.
$ npm run docs  
  1. Next Move to the ./docs directory
  2. First, run the clean command.
$ bundle exec jekyll clean  
  1. Second, run the build command.
$ bundle exec jekyll build  
  1. Finally, run the serve command and preview docs locally on http://127.0.0.1:4000/
$ bundle exec jekyll serve  

Note: Update documentation after updating excludes within on of the following index. files:

  • [api, services, types]
  • or create a new index.ts file and update the following files:
    1. typedoc.json -> Entry points for typedoc
    2. tsconfig.json -> Allows includes with '@' for example '@types'
    3. webpack.config.js -> Allows includes with '@' to work in ClubPoker Extension.

Documentation is built from index.ts files at head of the following folders: [api, services, types]

Storybook

  1. Build package components for use in storybook.
$ npm run build-storybook  
  1. Host storybook webpage
$ npm run storybook  

Permissions

  • identity: Required for OAuth2 authentication with Google Calendar.
  • activeTab: Required to execute the content script on the active tab.
  • scripting: Required to inject the content script.

Design

  • manifest.json: Configures the extension.
  • content/: Contains the content script for scraping data.
  • background/: Contains the background script for API interactions.
  • popup/: Contains the popup UI files.
  • icons/: Contains the extension icons.

Helpful Links:

Icons
Poker Icons

About

This is a Chrome extension intended to interface with clubwpt.com. It offers the ability to modify the timezone for tournaments, and save specified tournaments to a users Google Calendar for easy reminders.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published