azu / faao

Faao is a GitHub issue/pull-request client on Electron.

Faao

Faao is a GitHub Issue/Pull Request client on Electron/Browser.

Features

• Support Modern browser/mobile/Electron(recommenced)
• Support GitHub.com and GitHub Enterprise(GHE)
• Search Issue/Pull Request
  • Search Syntax is same with GitHub Search
• Mixed the result of search
  • e.g.) You can see the results of Created, assigned, mentioned as a single result
  • e.g.) You can see the results of repo:azu/todo on github.com and repo:azu-ghe/todo on GHE as a single result
• Support GitHub User Activity
• Quick to create issue
• Import/Export profile data
• Sync data between PCs/mobiles

Usage

Browser

• Open https://faao.netlify.com/

Electron

• Download binary

URL Schems

• faao://query/add?url=<url>&query=<queryName>: Add url to query

Development

Browser

yarn start
open http://localhost:3000/

Electron

yarn start
yarn run electron

How to pronounce "Faao"?

Same with How to say "faao"! (High Quality Voices) - YouTube

Structure

Domain

See Domain documents

UseCase

Visualization: Faao - UseCase architecture

And See UseCase documents

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Run test files in __tests__ directory by Jest.

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Related Efforts

• azu/github-issue-teev: [NW.js] GitHub Issue Manager(Viewer)
• Jasper: A flexible and powerful issue reader for GitHub
• Gitscout: A beautiful and optimized GitHub Issues experience for macOS

Author

• github/azu
• twitter/azu_re

License

MIT © azu

with based on korat's ViewPool implementation.

• https://github.com/pocke/korat/blob/f6beb9eb625fa2927ab19e8316110189dd0b6ab0/src/mainProcess/ViewPool.ts

faao's Issues

Shortcut for creating quick issue

GItHub c

Support User image

Support user image.

• GitHub API /user return avatarURL
• Show this avatar image in the setting list.

ColorBar should be ProgressBar

Current ColorBar is not meaningful.

We use https://dev.office.com/fabric#/components/progressindicator instead of it.
ColorBar work as Loading Indicator.

Dry-run mode

We want to get dry-run mode for testing

Unread

Unread manager

Refactor: EntityId

We should be unitfied Entity's id property.

• GitHubSearchStream accept id from constructor.
• Other entity create id in the constructor.

It make confuse.

Add Issue address

currently, only issue number.
we should add repo#number

preserve Queries

Queries should be saved on updating

SettingPanel should be reset on close

Activity

• Click account and show activity
• Acitivy is ranked sort
  • Priority Inbox in gmail
  • Online Passive-Aggressive Algorithms
• Use data - unread mander and other query data.

Quick Issue

create Quick issue feature.

1. input text
2. open issues?title&body

Remove default setting

We will remove default settings.

Setting for SearchList

We will can remove a SearchList.

• SearchList |Setting|Add|

Stream reload button

Reload feature

• Refresh
• Force refresh

Browser support

Work on Browser.

• polyfill
• Ignore electron.css
• gh-pages?

Test: ImportProfileJSONUseCase

ImportProfileJSONUseCase needs tests.

focus title when open quick issue

focus on title field.

Account use Facepile

use https://dev.office.com/fabric#/components/facepile

QuickIssueStore#receivePayload is slow

too heavy work.

Test: Add test for default state

We should test StoreGroup.
In other word, test initial state.

QuickIssue does't show until two click

Reproduce

1. Click Quick Issue -> No...
2. Click Quick Issue -> Show

Add "Open In Broser" in context

We want to open OS default browser.

Sort SearchList by name

We want to have sortId for searchList.
Insteadof it, we sort searchist by name.

The user can does sort by own name.

Refresh: clear and load

1. Stream: A
2. Stream: B

Fetch A and add the result to B stream.
It is buggy.

Shortcut issue

keyboard shortcut should be ignored in webview.

Prevent link

Prevent link transion in the window.
Always open in default browser.

fill apiHost and webHost by default

Almost user use github.com.
We want to change apiHost and webHost default value.

GitHubSetting UI

Add GitHub account settting UI.

Sort items

support sort feature.

default: updated sort

almin-logger: loud "Currently executing UseCases" log

It seems that "Currently executing UseCases" is loudness.

https://github.com/almin/almin/blob/2675d7c127479995ff36f1ee1ed232f785dbf34b/packages/almin-logger/src/AsyncLogger.js#L133

It will be logged at once during stores.

Release

First Release

• Electron app
• Mobile #51
• Activity #53
• Debug - to clear invalid data

Delete Accounts/Queries

UI need

When startup, scroll to focused item

Currenlty, not scrollIntoView

Auto Reload stream

Auto reload stream feature.

Perf: introduce GA

Leveraging the Performance Metrics that Most Affect User Experience  |  Web  |  Google Developers

We want to introduce performance metrics

display status: close or opened

Display Issue status

Stream Theme

We should set theme color/image for each stream.
It will be improved recognizable between GHE and GitHub and private.

support to update query

support edit query

1. Add Context Menu
2. Update SaveQueryUseCase

Mobile: Panel submit button can't tap

scroll over

Does't Update query

1. Update Query setting.
2. But, not reflect this changes

Imports/Exports

Imports/Exports feature is needed.

It help

• sort flexible
• copy/past exist setting
• sync other computer

Background

We want to sort feature for SearchList.
But, it is difficult to implement sort feature.
It is complex.

Refactor: activeQuery and activeSearchList

We have implemented SearchQueriesAndOpenStreamUseCase at 1eead96
It can merge streams.

Currently, two separated abstraction for search/query.

Query and SearchList.

• SearchList has queries
• Query is a Query.

Currently, activeQuery is one of SearchList or Query.
Should we have new abstraction for it?

Sync with gist

We want to add sync feature betweetn A PC <-> B PC <-> C mobile.

We can use gist as backup data place

• Encrypt exported data with pass phase
• Import data and decrypt with pass phase

We want to get safe-crypt API.

fromJSON shoule be catch

We should use fromJSON with try-catch.
because, json schmea will be changed at sometimes.
To prevent white screen by chaning schema.

try { fromJSON } catch(){}

Show error when invliad query

Wide screen

If show full-webview in thescreen, the webview should be wider by default.

Stream: merge issue?

We should test it.
When update with same id, which is overwritten?

Support permanet

We should save data to localstorage.

• GitHubSetting
• Queries

Cache

• Stream
• Queries

Fix: support reload in searchList

Currently, reload only work in query mode.

Implement AddListPanel

Currently, "Add List" has not UI.