Giter VIP home page Giter VIP logo

streamdeck-japanesereviews's Introduction

Stream Deck Japanese Reviews

A collection of review trackers for various Japanese review websites. The following sites are supported:

Name Description Website
Bunpro Grammar & Vocab https://bunpro.jp
Kitsun Vocabulary https://kitsun.io
Wanikani Kanji https://wanikani.com

Icons for each website are shown with a counter of the number of reviews currently waiting, which updates every 10 minutes. Updates are timed to 1 minute after the hour to ensure hourly updates (esp. Wanikani) are shown as soon as possible.

Button Display

Property Inspector Example

Clicking on each button will open to the relevant website in your default browser, with reviews being one click away.

Getting Started

This plugin requires the Stream Deck software to be installed on your computer.

There are a few ways to utilize this Stream Deck plugin:

  1. (Recommended) Download the latest released version from the Stream Deck store by searching for "Japanese Reviews"

  2. Download the latest released version from Github and run com.ascend.japanesereviews.streamDeckPlugin.

  3. Copy the entire com.ascend.japanesereviews.sdPlugin folder under /src into the following folder:

    • On Windows: %appdata%\Elgato\StreamDeck\Plugins\
    • On macOS: ~/Library/Application Support/com.elgato.StreamDeck/Plugins/

Building

Building is optional and only necessary for packaging the .streamDeckPlugin for distribution. For local usage and testing, copying the entire sdPlugin to the Stream Deck plugin folder is sufficient.

To build, simply run /build/build.ps1 using Powershell, navigate to the build directory and run the following command:

./DistributionTool -b -i ../src/com.ascend.japanesereviews.sdPlugin -o ./

A .streamDeckPlugin file will be output in the build folder, which can be run to install the plugin.

Contributing

Feel free to suggest feature changes or add support for additional Japanese review sites by opening a pull request.

Run npm install from the /src folder to retrieve ESlint configuration. All javascript files follow Airbnb Javascript coding styles.

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.