fractalnote

KO | EN

gitlite — search

#php #javascript #dotfiles #python #css #java #hacktoberfest #unmaintained #c #objective-c #cli #bundle

★ 20 Open GitHub ↗

FractalNote is online editor of hierarchical notes (or note trees) for Nextcloud server. You can view/edit CherryTree (*.ctb) files with it in browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/alboro/fractalnote.svg?branch=master)](https://travis-ci.org/alboro/fractalnote)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/fractaldem)

# What is it?
_FractalNote_ is online editor of hierarchical notes (or note trees) for Nextcloud server.

You can view/edit CherryTree (*.ctb) files with it in browser.

Current development phase is ``pre-alpha``. Just nodes of plain text are editable, others are read-only.

[See FractalNote in action](http://cloud.aldem.ru/index.php/apps/fractalnote?f=/demo.ctb)

# About Nextcloud
This is self-hosted Dropbox/Google Drive analog.
It is able to synchronise your private files between all your devices. [More about...](https://nextcloud.com/install/)

# How to use _FractalNote_?
* Use [CherryTree program](https://www.giuspen.com/cherrytree/#downl) for windows/linux desktop computers to create hierarchical notes.
* Save your hierarchical note tree as _[filename].ctb_ with [CherryTree program.](https://www.giuspen.com/cherrytree/)
* Upload _[filename].ctb_ to Nextcloud
* Edit uploaded file online: ``https://[your-cloud-server]/index.php/apps/fractalnote?f=[filename].ctb``
* Install Nextcloud desktop [synchronisation client.](https://nextcloud.com/install/#install-clients)
* Put _[filename].ctb_ under Nextcloud synchronisation folder of your desktop computer. From now the file will be uploaded into server automatically after every saving.
* In CherryTree program preferences keep checked autosave option and Edit->Preferences->Miscellaneous->``Reload after external update to CT* file`` option. From now file changes made online will be downloaded automatically even while you navigating through the file with CherryTree program.
* _[filename].ctb_ size should not be big (about ``<= 5MB``), because for now the full file gets loaded with every page refresh in browser.

# Installation
## Server requirements
* PHP ``>= 7.2``
* Nextcloud ``>= 15.0``
## Steps
* Install into your web server [Nextcloud](https://nextcloud.com/install/#instructions-server)
* (This step is not required.) To open _[filename].ctb_ from file list nextcloud app you need:

Add ``ctb`` file type to the ``[nextcloud install folder]/config/mimetypemapping.json`` like that:
```
{
    "ctb": ["application/cherrytree-ctb"]
}
```
Run in the command line:
```
cd [nextcloud install folder]
sudo -u www-data ./occ maintenance:mimetype:update-db --repair-filecache
```
* Place _FractalNote_ in ``[nextcloud install folder]/apps/fractalnote``
* [Install composer](https://getcomposer.org/download/)
* Run
```
cd [nextcloud install folder]/apps/fractalnote
composer install
```
* Enable _FractalNote_ in Nextcloud settings UI or by the command
```
cd [nextcloud install folder]
sudo -u www-data ./occ app:enable fractalnote
```

# Running tests
After [Installing PHPUnit](http://phpunit.de/getting-started.html) run:
```
phpunit -c phpunit.xml
```

# Tehnologies used
* JQuery jsTree plugin, that provides interactive trees: https://github.com/vakata/jstree
* Reponsive jsTree Twitter Bootstrap 3 Compatible Theme: https://github.com/orangehill/jstree-bootstrap-theme
* Handlebars.js https://github.com/wycats/handlebars.js/
* Inspired by awesome CherryTree: https://github.com/giuspen/cherrytree

fractalnote

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README