thedesk/README.md

rewrite-overallブランチへようこそ🎃

このブランチはコードを最初から全部読み直して書き直そうという途方もなく壮大なプロジェクトです。

1周目では、

• 脱jQuery
• 脱onclick
• 脱コールバック地獄
• 重複してるやつや使ってないやつを消す

という極めて当たり前のやつをやっていきます。

以下いつものREADME

TheDesk

Mastodon/Misskey client for PC(Windows/Linux/macOS)
オープンソースSNSマストドン/MisskeyのPC向けクライアント日本語はこちら

Download:TheDesk

License

GNU General Public License v3.0

The icon is provided under Creative Commons BY-NC-SA
Press Kit

• PNG 512x512
• SVG 4095x4096
• ico 256x256
• icns old

The default sounds of notifications is provided Creative Commons BY

Terms of Use

• 利用規約(Terms of Use(ja))
• プライバシーポリシー(Privacy Policy(ja))

Language

• 日本語(Japanese)
• English
• de, cs, bg(from Crowdin)

Translation

Crowdin project is available! Visit: https://translate.thedesk.top

Run on developer mode

npm run dev on app folder.

Contributors

Build for macOS

• toneji

Build for Linux

• popn_ja

Fellow coder

• kPherox

Build

You have to use either npm or yarn. Whichever you use, it works well.

npm

git clone https://github.com/cutls/TheDesk
cd TheDesk/app
npm install
npm install --only=dev
npm run construct

yarn

git clone https://github.com/cutls/TheDesk
cd TheDesk/app
# Linux or macOS
yarn install --no-lockfile
# Windows
yarn install

yarn construct

run npm run dev or yarn dev to launch developer version with console(click view)

electron-builder(Recommended)

Use scripts(they can work well with npm, yarn).

npm

# Build for current platform
npm run build

# Select build target
## Windows
npm run build:win

## Windows and Linux (The macOS target should run on macOS. So, this option hasn't include the build for macOS)
npm run build:all

yarn

# Build for current platform
yarn build

# Select build target
## Windows
yarn build:win

## Windows and Linux (The macOS target should run on macOS. So, this option hasn't include the build for macOS)
yarn build:all

Config is all on package.json

electron-packager

npm install --save-dev electron-rebuild

Linux/macOS
./node_modules/.bin/electron-rebuild
Windows
.\node_modules\.bin\electron-rebuild.cmd

To install Python 2.x and Visual C++ for Windows, before running npm install --save-dev electron-rebuild
npm install --global windows-build-tools

Windows
electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --win32metadata.CompanyName="TheDesk&Cutls.com" --win32metadata.FileDescription="TheDesk" --win32metadata.OriginalFilename="TheDesk" --win32metadata.InternalName="TheDesk" --win32metadata.ProductName="TheDesk" --platform=win32 --arch=all --electron-version=4.0.5 --icon=.\app\thedesk.ico --overwrite
Linux
electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --platform=linux --arch=x64,ia32 --electron-version=4.0.5 --overwrite
macOS
electron-packager ./app TheDesk --executable-name="TheDesk" --app-copyright="Copyright (c) TheDesk 2018 Cutls.com 2015 All Right Reserved" --platform=darwin --arch=all --electron-version=4.0.5 --icon=./app/icon.icns --overwrite

PWA support

TheDesk is a wed-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 npm run 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)

Check the app on Chrome or Firefox: Here (it follows the master branch, so not stable.)

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 npm i???

No, if your npm says materialize-css has vulnerabilities(CVE-2019-11002/3/4), look at here under discussion.