Skip to content

Files

Latest commit

h13i32marugitbook-bot
h13i32maru
and
gitbook-bot
GitBook: [#228] No subject
Aug 16, 2022
9fe29a1 · Aug 16, 2022

History

History
106 lines (73 loc) · 7.89 KB

faq.md

File metadata and controls

106 lines (73 loc) · 7.89 KB

FAQ

Concept

Jasper is more about flexibility than easily, and we aim to tailor the tool's use to a variety of use cases. We've tried to avoid deviating from the core functionality (Stream) of the tool to avoid becoming a "flexible but complex" tool.

This gives us an advantage over other similar tools. However, our emphasis on flexibility means that we are sometimes inferior to similar tools in the following respects

  • Hurdles to master
    • Requires an understanding of GitHub search
    • Overspecified for occasional use.
  • Maintenance of user settings
    • The user needs to maintain the Stream settings to suit the situation.
  • Load on the server when using GHE
    • Jasper is a heavy user of the GitHub Search API

That's why we're developing Jasper, balancing flexibility with these shortcomings.

Smartphone App

Jasper is compatible with Mac/Window/Linux, but it does not support Android/iOS smartphone apps. However, by integrating GitHub Notifications with Jasper, issues viewed from your smartphone's browser can be marked as read in Jasper as well. See "Smartphone integration" for more information.

Synchronization of Multiple Machines

Jasper does not support multi-machine issue synchronization, although some users have used file synchronization services such as Dropbox to achieve this on their own. But we do not officially support this at this time. If you would like to use this service, try synchronizing the directories you open by going to Menu → Dev → Open Data Directory.

Tabbed Browser

Jasper's built-in browser does not support tabbed browsers. If you wish to view multiple issues at the same time, please use an external browser.

Issue display speed

When viewing an issue in Jasper's internal browser, it may be slow, but this is due to a slow TTFB (time to first byte) on the GitHub side. I haven't been able to work around this on the Jasper side at the moment.

Jasper blank screen

If you get a blank screen after starting Jasper, your data may have been corrupted. Follow these steps to delete and initialize the data in Jasper

  1. Select Menu → Dev → Open Data Directory to view the directory
  2. Quit Jasper
  3. Delete the config.json and main.db in the directory we just left.
  4. Launch Jasper and re-set up

This will delete the Stream you've created and any issues you've been holding in Jasper, but it will not affect any data on GitHub.

Polling the GitHub Search API

Jasper's core functionality, Stream, is achieved by polling the GitHub Search API on a regular basis. Short polling intervals place a heavy load on the GitHub side, while longer intervals result in poor user experience (i.e., issue updates). Jasper strikes a balance between these two by designing the polling as follows

  • Instead of polling each Stream, poll the whole Jasper as one poll.
    • Therefore, if there are too many Streams, the update interval per Stream will increase.
      To mitigate this problem, see "Optimizing the update interval".
  • Automatically extend the polling interval when the GitHub API rate limit is reached
    • The rate limit of the GitHub Search API is 10 requests per 60 seconds. The default polling interval is 6 requests per 60 seconds, so the rate limit will never be reached
    • GHE(GitHub Enterprise) may have its own rate limit set. Please contact the GHE administrator for more information.

Supporter Subscriptions

If you want to support the developer (@h13i32maru), it would be great if you could make a small subscription through "Support Subscription".

Feedback

Please feel free to give us your feedback, and we'd love it if you could write a blog post about Jasper and #jasperapp on Twitter. If you have a bug or feature request, please send it to jasperapp/jasper. We'll do our best to address them as much as possible.

Competitor

Similar to Jasper, tools to manage issue viewing and notification are currently available (2020.09)

Tool Active period
Jasper ✅ 2016.06 ~ 2020.07
Trailer ✅ 2013.08 ~ 2020.09
DevHub ✅ 2017.05 ~ 2020.08
Octobox ✅ 2016.12 ~ 2020.09
GitHawk ✅ 2017.06 ~ 2020.05
Deck 2016.03 ~ 2019.12
faao 2017.05 ~ 2019.12
Cashew 2017.11 ~ 2019.04
Bee 2013.08 ~ 2018.09
Gitscout 2015.11 ~ 2017.05
Ship 2016.01 ~ 2017.01
DeckHub 2016.02 ~ 2016.04
BugHub 2013.04 ~ 2015.11

Articles

Developer articles

User articles