8000 GitHub - GP-S/laverna at dev ยท GitHub
[go: up one dir, main page]

Skip to content
GP-SPublic
forked from Laverna/laverna

About

Laverna is a JavaScript note taking application with Markdown editor and encryption support. Consider it like open source alternative to Evernote.

Resources

Stars

0 stars

Watchers

1 watching

Forks

ย 
ย 

Latest commit

ย 

History

2,188 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Laverna | The open source note-taking app

๐Ÿ”– ย ๐Ÿ” ย ๐Ÿ“„ย 

A clean, lightweight alternative to Evernote that keeps your notes encrypted.
Demo: https://laverna.cc ย โ€“ or โ€“ย  http://laverna.github.io/static-laverna

Build Status Coverage Status Code Climate Version

Laverna uses the Marionette JS framework, Gulp and runs on Node.js. The test runner is tape

Features

  • Markdown editor based on Pagedown
  • Synchronization with cloud storage via Dropbox or RemoteStorage
  • Multiple editing modes: normal, preview, and distraction free
  • Offline access to your notes
  • WYSIWYG control buttons
  • Syntax highlighting, MathJax support
  • Robust keyboard shortcuts


Security

  • Client-side document encryption
  • No registration required. Laverna manages signup/login via security tools built in to all modern browsers.
  • By default, Laverna stores notes using the database in your browser (such as indexedDB or localStorage). This means that no data is synced to the cloud without your permission.

Quick Start (recommended)

  • Open laverna.cc and get started in less than 30 seconds.
  • No extra steps are required!

Install Desktop App (beta)

After downloading the file for your operating system, unpack the .zip file. Inside the unpacked folder (e.g. cd ~/Applications/laverna-0.7.51), run an executable: laverna.exe for Windows, laverna for Linux and Mac.

Windows

macOS

Linux

Arch Linux (or derived distributions)

  • Install the package hosted here. Once installed, run: $ pacaur -S laverna

Running into issues with Arch Linux installation? Report here or contact @funilrys on Gitter here.

Previous Releases

Install a Prebuilt Version

1. Download via wget:

$ wget https://github.com/Laverna/static-laverna/archive/gh-pages.zip -O laverna.zip

2. Unpack the downloaded archive:

$ unzip laverna.zip

3. Open index.html (from inside the Laverna folder) in any browser.



Developer Install & Documentation

Setting up the Laverna development environment only takes a few minutes. To run locally, you need to have the following installed:

  • Node.js version 6.11.4. Laverna works with other previous Node versions, but requires changes to package.json and is not recommended.
  • MongoDB
  • Git (note: Windows users need to set the PATH variable for git after installation).

Part One: Install Laverna

If you're planning to contribute to the project's development, hit the fork button at the top of the page and move on to step 2.

1. Clone the Laverna repository:

$ git clone git@github.com:Laverna/laverna.git

2. Navigate to project directory and checkout dev branch:

$ cd laverna

# unless you're patching bugs in the latest release, switch to dev branch:
$ git fetch && git checkout dev

3. Install Gulp:

$ npm install gulp
$ npm install -g gulp

4. Install dependencies and build:

$ npm run setup

5. Start Laverna:

$ gulp

Part Two: Setup Signal Server

1. Clone the repository for Laverna's backend Signal Server:

$ git clone git@github.com:Laverna/server.git

$ cd server && npm install

3. Configure the Signal Server:

Copy .env.example to .env and change configs in the new file.


4. Start the Signal Server:

$ npm start

Coding Style Guidelines

We ask that you use either plain JavaScript or the Marionette.js framework (for more details on the preferred coding style see .editorconfig). All experimental changes are pushed to the dev branch. Feature changes need to be done on either dev or a branch that uses dev as its parent.

Localizations are available here.

Encryption

The current Laverna release (on master) uses the SJCL library to implement the AES algorithm.

However, in our effort to permanently enhance the application's security, Laverna is implementing OpenPGP encryption via OpenPGP.js.

Donations

Support Laverna

License

Published under MPL-2.0 License. Laverna uses a lot of other libraries and each of these libraries use different licenses.

About

Laverna is a JavaScript note taking application with Markdown editor and encryption support. Consider it like open source alternative to Evernote.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

0