https://github.com/turtl/desktop

Turtl's desktop app
https://github.com/turtl/desktop

Last synced: 18 days ago
JSON representation

Turtl's desktop app

• Host: GitHub
• URL: https://github.com/turtl/desktop
• Owner: turtl
• License: gpl-3.0
• Created: 2014-03-27T07:30:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T03:27:23.000Z (over 3 years ago)
• Last Synced: 2024-08-01T00:55:08.608Z (3 months ago)
• Language: JavaScript
• Size: 524 KB
• Stars: 687
• Watchers: 41
• Forks: 48
• Open Issues: 64
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Turtl desktop

=============

_Opening an issue? See the [Turtl project tracker](https://github.com/turtl/tracker/issues)_

This is the desktop app wrapper around the Turtl [core](https://github.com/turtl/js).

It provides a native experience for Windows, Linux, and OSx allowing local packaging

of Turtl for desktop platforms.

## Setup

Let's assume you have Node.js/NPM install already. Make sure you have [NWJS](https://github.com/nwjs/nw.js)

installed on your machine and in your PATH. Also the `rsync` utility is used

throughout the Turtl build processes, so please make sure you have it installed.

```bash

mkdir turtl

cd turtl/

git clone https://github.com/turtl/js

# make sure to follow the build instructions for turtl core: https://github.com/turtl/core-rs

git clone https://github.com/turtl/core-rs core

git clone https://github.com/turtl/desktop

cd js/

npm install

cp config/config.js.default config/config.js

cd ../desktop/

npm install

make electron-rebuild

```

NOTE (mostly to self): in windows, run `electron-rebuild` in cmd, not in

msys2/cygwin. Something with paths, npm, etc etc etc. Who the hell knows.

## Building

There are a few targets, but the most gratifying is

```bash

make run

```

Which runs the build and opens electron with Turtl loaded.