Skip to content

alboro/fractalnote

Repository files navigation

Build Status Donate

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

About Nextcloud

This is self-hosted Dropbox/Google Drive analog. It is able to synchronise your private files between all your devices. More about...

How to use FractalNote?

  • Use CherryTree program for windows/linux desktop computers to create hierarchical notes.
  • Save your hierarchical note tree as [filename].ctb with CherryTree program.
  • 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.
  • 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
  • (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
  • 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 run:

phpunit -c phpunit.xml

Tehnologies used

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published