https://github.com/turtl/js

Turtl's main app interface.
https://github.com/turtl/js

Last synced: 5 days ago
JSON representation

Turtl's main app interface.

• Host: GitHub
• URL: https://github.com/turtl/js
• Owner: turtl
• License: gpl-3.0
• Created: 2013-08-18T18:34:13.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-11-27T22:09:48.000Z (12 months ago)
• Last Synced: 2024-08-01T12:34:51.261Z (3 months ago)
• Language: JavaScript
• Homepage: https://turtlapp.com
• Size: 8.91 MB
• Stars: 517
• Watchers: 43
• Forks: 145
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - turtl/js - Turtl's main app interface. (others)

README

        
[Turtl](https://turtlapp.com/)

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

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

This is the heart of Turtl!

It's the javascript core that runs the app whether on desktop or mobile. It

contains Turtl's interfaces, logic, crypto, etc.

## Documentation

If you're interested in how Turtl works, [check out the docs](https://turtlapp.com/docs/).

## Building

Turtl uses a makefile to generate itself. Here's a few commands to get you started

(this assumes you have Node.js/npm installed already):

```bash

mkdir turtl

cd turtl/

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

cd js/

npm install

make

```

Running `make` here generates all the assets for the project and it's now ready

to be run by any webserver (just make sure all requests are sent to `index.html`,

see the `.htaccess` file for reference).