130 lines
5.3 KiB
Markdown
130 lines
5.3 KiB
Markdown
<img src="https://thedesk.top/img/top.png" width="300" align="left">
|
|
<img src="https://thedesk.top/img/desk.png" width="150" align="right">
|
|
|
|
# TheDesk
|
|
|
|
[](https://travis-ci.org/cutls/TheDesk)
|
|
[](https://translate.thedesk.top/project/thedesk)
|
|
[](https://bit.ly/31zqMmZ)
|
|
[](https://github.com/cutls/TheDesk/releases)
|
|
|
|
Mastodon/Misskey client for PC(Windows/Linux/macOS)
|
|
オープンソースSNSマストドン/MisskeyのPC向けクライアント[日本語はこちら](README_ja.md)
|
|
|
|
Download:[TheDesk](https://thedesk.top)
|
|
|
|
<a href="https://www.patreon.com/cutls"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="Become a Patron!" width="160"></a>
|
|
<a href="https://liberapay.com/cutls/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>
|
|
|
|
|
|
## GitHub Releases notice
|
|
|
|
### For Windows and macOS
|
|
|
|
On GitHub Releases, `-store.*` assets are made for some application store or manager(Homebrew, Microsoft Store).
|
|
They do not check the latest version(Which you can get the latest ver or not depends on the store)
|
|
|
|
### For Linux
|
|
|
|
On GitHub Releases, `-normal.snap` assets are **not** made for Snapcraft.
|
|
No suffix version .snap does not check if there is the latest version(Which you can get the latest ver or not depends on the store), so it is for Snapcraft.
|
|
|
|
.deb always checks if there is the latest version
|
|
|
|
## License
|
|
|
|
[GNU General Public License v3.0](https://github.com/cutls/TheDesk/blob/master/LICENSE)
|
|
|
|
The icon is provided under [Creative Commons BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/)
|
|
[Press Kit](https://d2upiril6ywqp9.cloudfront.net/press/TheDesk+PressKit.zip)
|
|
|
|
* [PNG 512x512](https://d2upiril6ywqp9.cloudfront.net/press/thedesk.png)
|
|
* [SVG 4095x4096](https://d2upiril6ywqp9.cloudfront.net/press/thedesk-fullcolor.svg)
|
|
* [ico 256x256](https://d2upiril6ywqp9.cloudfront.net/press/thedesk.ico)
|
|
* [icns old](https://d2upiril6ywqp9.cloudfront.net/press/thedesk.icns)
|
|
* [Illustrator .ai](https://d2upiril6ywqp9.cloudfront.net/press/thedesk.ai)
|
|
|
|
The default sounds of notifications is provided [Creative Commons BY](https://creativecommons.org/licenses/by/4.0/)
|
|
|
|
## Privacy Policy
|
|
|
|
* [プライバシーポリシー(Privacy Policy(ja))](https://thedesk.top/priv.html)
|
|
|
|
## Language
|
|
|
|
* 日本語(Japanese)
|
|
* 日本語, 関西(Japanese, Kansai)
|
|
* English
|
|
* български(Bulgarian) with [translate project](https://translate.thedesk.top/project/thedesk/bg)
|
|
* Česky(Czech) with [translate project](https://translate.thedesk.top/project/thedesk/cs)
|
|
* Deutsch(German) with [translate project](https://translate.thedesk.top/project/thedesk/de)
|
|
* Español, argentina(Spanish, Argentina) with [translate project](https://translate.thedesk.top/project/thedesk/es-AR)
|
|
* italiano(Italian) with [translate project](https://translate.thedesk.top/project/thedesk/it-IT)
|
|
|
|
and more...
|
|
|
|
### Translation
|
|
|
|
Crowdin project is available! Visit: https://translate.thedesk.top
|
|
|
|
### Run on developer mode
|
|
|
|
**you cannot use npm or any other package manager without Yarn.**(it will throw error)
|
|
|
|
* `yarn`
|
|
* `yarn dev`
|
|
|
|
## Contributors
|
|
|
|
Build for macOS(Now: Travis CI)
|
|
|
|
* [toneji](https://minohdon.jp/@toneji)
|
|
|
|
Build for Linux(Now: Travis CI)
|
|
|
|
* [popn_ja](https://popon.pptdn.jp/@popn_ja)
|
|
|
|
Fellow coder
|
|
|
|
* [kPherox](https://pl.kpherox.dev/kPherox)
|
|
|
|
## Build
|
|
|
|
**you cannot use npm or any other package manager without Yarn.**(it will throw error)
|
|
|
|
```sh
|
|
git clone https://github.com/cutls/TheDesk
|
|
cd TheDesk/app
|
|
yarn install
|
|
|
|
yarn build
|
|
```
|
|
|
|
run `yarn dev` to launch developer version with console(if close dev mode, you may press Ctrl+C twice.)
|
|
|
|
### Restriction with macOS build
|
|
|
|
Requires XCode(XCode Command Line Tools) to use iTunes NowPlaying
|
|
|
|
Built assets should be notarized after building by expensive Apple Developer user. To disable it, see `app/build/notarize.js` (beta)
|
|
|
|
### PWA support
|
|
|
|
TheDesk is a web-based app, so you can run it on a browser. Of course, the main stream is as Electron. Some features won't work as well as Electron.
|
|
|
|
You can run `yarn build:pwa` to build as PWA, including `manifest.json` and the ServiceWorker.
|
|
|
|
**You have to rename `node_modules` to `dependencies` to run as a web application. (restricted by Netlify, but always you should do to run as PWA)**
|
|
|
|
Check the app on Chrome or Firefox: [Here](https://app.thedesk.top) (it follows the `master` branch, so not stable.)
|
|
[](https://app.netlify.com/sites/thedesk/deploys)
|
|
|
|
## Pleroma support
|
|
|
|
Did you find a bug with Pleroma accounts?
|
|
Pleroma **does not** follow Mastodon API rules completely although Pleroma developers say so.
|
|
Please write issues to improve TheDesk affinity with Pleroma.
|
|
|
|
## Vulnerabilities when `yarn install`???
|
|
|
|
No, if your npm says materialize-css has vulnerabilities(CVE-2019-11002/3/4), look at [here](https://github.com/Dogfalo/materialize/issues/6286) under discussion, but I do not think this report is really fatal. |