framanotes-js

framanotes-js

Name Last Update
.build Loading commit data...
config Loading commit data...
controllers Loading commit data...
css Loading commit data...
fonts Loading commit data...
handlers Loading commit data...
images Loading commit data...
library Loading commit data...
locales Loading commit data...
models Loading commit data...
scripts Loading commit data...
tests Loading commit data...
turtl Loading commit data...
views Loading commit data...
.gitignore Loading commit data...
.htaccess Loading commit data...
CONTRIBUTING.md Loading commit data...
LICENSE Loading commit data...
Makefile Loading commit data...
README.md Loading commit data...
main.js Loading commit data...
package.json Loading commit data...

Turtl

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