b15f173200
refs #543 Add description of shortcut in README |
||
|---|---|---|
| .circleci | ||
| .electron-vue | ||
| .github/ISSUE_TEMPLATE | ||
| build | ||
| dist | ||
| packages | ||
| plist | ||
| src | ||
| static | ||
| test | ||
| .babelrc | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .nvmrc | ||
| .stylelintignore | ||
| .stylelintrc.json | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| LICENSE.txt | ||
| README.md | ||
| app-store.svg | ||
| appStore.sh | ||
| appveyor.yml | ||
| package-lock.json | ||
| package.json | ||
| screenshot.gif | ||
| screenshot.png | ||
| sideci.yml | ||
README.md
Whalebird
Whalebird is a mastodon client for desktop application.
Feature
- An interface like slack
- Notify to desktop
- Streaming
- Many keyboard shortcuts
- Manage multiple accounts
Shortcuts
| Mac | Linux, Windows | |
|---|---|---|
| Toot, Reply | Cmd + Enter | Ctrl + Enter |
| Change accounts | Cmd + 1, 2, 3... | Ctrl + 1, 2, 3... |
| Jump to another timeline | Cmd + k | Ctrl + k |
| Open new toot window | Cmd + n | Ctrl + n |
| Select next toot | j | j |
| Select previous toot | k | k |
| Reply to the toot | r | r |
| Reblog the toot | b | b |
| Favourite the toot | f | f |
| Open details of the toot | o | o |
| Open account profile of the toot | p | p |
Install
Mac
Or you can download .dmg from release page.
So on, you can install from Homebrew:
$ brew update
$ brew cask install whalebird
✨ Thanks to @singingwolfboy for adding it to homebrew-cask.
Linux
You can download .deb or .rpm from release page.
If you do not want to use package manager, please download .tar.bz2 file and docompress it.
Or please install the app from snapcraft.io.
$ sudo snap install whalebird
Windows
You can download .exe from release page.
Development
We'd love you to contribute to Whalebird.
Minimum requirements for development
- Node.js greater than or equal version 8.9.0
- npm or yarn
Getting started
# clone this repository
$ git clone https://github.com/h3poteto/whalebird-desktop.git
$ cd whalebird-desktop
# install dependencies
$ npm install
# serve with hot reload at localhost:9080
$ npm run dev
How to add new language
- First, please prepare translation, and translation missing file for your language.
- Next, add your language to constants like French.
- Finally, add your language at here.
If there is something unknown, please refer this pull request: https://github.com/h3poteto/whalebird-desktop/pull/502
Release
Binary
When you build release packages, please use electron-builder.
# for linux
$ npm run build:linux
# for mac
# This command automatically loads the Developer ID Application certificate from your keychain.
$ npm run build:mac
AppStore
Please prepare certificates on your Apple developer console. The following keys are required:
- Mac App Distribution:
3rd Party Mac Developer Application: NAME (TEAM_ID) - Mac Installer Distribution:
3rd Party Mac Developer Installer: NAME (TEAM_ID)
and register your KeyChain.
Then, create a Mac App ID like org.whalebird.desktop.
$ npm run build:mas
# This command automatically loads the certificates from you keychain.
$ ./appStore.sh
After that, the .pkg file is created under ./packages.
Please upload the .pkg to App Store using Application Loader in Xcode.
Snapcraft
First, please prepare snapcraft command.
$ brew install snapcraft
And prepare docker environment which is used in snapcraft building.
Build app for linux.
$ npm run build:linux
And upload.
$ snapcraft push build/whalebird_1.0.0_amd64.snap --release stable
License
The software is available as open source under the terms of the MIT License.