Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/encryptic-team/encryptic
An encryption-focused open source note taking application
https://github.com/encryptic-team/encryptic
Last synced: 10 days ago
JSON representation
An encryption-focused open source note taking application
- Host: GitHub
- URL: https://github.com/encryptic-team/encryptic
- Owner: encryptic-team
- License: mpl-2.0
- Created: 2018-10-07T02:28:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T04:04:24.000Z (11 months ago)
- Last Synced: 2024-08-01T12:19:15.544Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 5 MB
- Stars: 349
- Watchers: 17
- Forks: 40
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Encryptic | The open source note-taking app
Warning: This project is deprecated.
🔖 🔏 📄
An encryption-focused open source note taking application.
Website | Demo
Encryptic is based upon the Laverna Project
[](https://travis-ci.org/encryptic-team/Encryptic)
[](https://coveralls.io/github/encryptic-team/Encryptic)
Gitter
|
Wiki
|
Contribute
Encryptic 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](#encryption)
* No registration required. Encryptic manages signup/login via security tools built in to all modern browsers.
* By default, Encryptic 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 [app.encryptic.org](https://app.encryptic.org/) and get started in less than 30 seconds.
* No extra steps are required!
## Install Standalone Desktop App (beta)
**NOTE: IF YOU ARE UPGRADING FROM AN OLD VERSION OF Encryptic, BACKUP EVERYTHING FIRST. THIS CODE HAS BEEN TESTED BUT MANY THINGS HAVE CHANGED. DATA LOSS IS POTENTIAL.**
Install a version of Encryptic from here:
https://github.com/encryptic-team/Encryptic/releases/
### Post installation
None. Removed the signal server component for the time being.
#### Arch Linux (or derived distributions)
* Install the package [encryptic](https://aur.archlinux.org/packages/encryptic/) with your favorite AUR helper (e.g. `$ yay -S encryptic`)
> *Running into issues with Arch Linux installation? Report [here](https://github.com/funilrys/PKGBUILD/issues/new) or contact [@funilrys](https://github.com/funilrys) on Gitter [here](https://gitter.im/funilrys_/PKGBUILD)*.
### Previous Releases
* All historical releases [are available here](https://github.com/encryptic-team/encryptic/releases).
## Developer Install & Documentation
Setting up the Encryptic development environment only takes a few minutes. To run locally, you need to have the following installed:
* [Node.js version 8.11.4 or 10.9.0](https://nodejs.org/). Encryptic works with other previous Node versions, but requires changes to `package.json` and is not recommended.
* [Git](https://git-scm.com/book/en/v2) (note: Windows users need to set the PATH variable for git after installation).
* [Yarn](https://yarnpkg.com/en/) You can use npm but it's not recommended due to inconsistencies observed in the modules installed.
### Part One: Install Encryptic
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 Encryptic repository:**
With SSH :
```bash
$ git clone [email protected]:encryptic-team/encryptic.git
```
With HTTPS :
```bash
$ git clone https://github.com/encryptic-team/encryptic.git
```
**2. Navigate to project directory and install gulp and yarn globally:**
```bash
$ cd encryptic
$ npm install -g gulp
$ npm install -g yarn
```
**4. Install dependencies and build:**
```bash
$ yarn
```
\- or -
```bash
$ npm run setup
```
**5. Start Encryptic:**
```bash
$ gulp
```
**6. Point a web browser to http://localhost:9000**
## Coding Style Guidelines
We ask that you use either **plain JavaScript or the [Marionette.js](http://marionettejs.com/) framework** (for more details on the preferred coding style see [.editorconfig](https://github.com/encryptic-team/Encryptic/blob/master/.editorconfig)).
## Encryption
**In our effort to permanently enhance the application's security**, Encryptic is implementing OpenPGP encryption via [OpenPGP.js](https://github.com/openpgpjs/openpgpjs).
## Support Encryptic
* Hit the star button on [GitHub](https://github.com/encryptic-team/encryptic)
* Like us on [alternativeto.net](http://alternativeto.net/software/Encryptic/)
* Contribute!
## License
Published under [MPL-2.0 License](https://www.mozilla.org/en-US/MPL/2.0/).
Encryptic uses a lot of other libraries and each of these [libraries use different licenses](https://github.com/encryptic-team/encryptic/blob/master/package.json).