Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 883 Bytes

README.md

File metadata and controls

32 lines (22 loc) · 883 Bytes

Opening an issue? See the Turtl project tracker

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.

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):

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).