f7cloud_client/apps/notes/README.md

Notes

The Notes app is a distraction free notes taking app for F7cloud. It provides categories for better organization and supports formatting using Markdown syntax. Notes are saved as files in your F7cloud, so you can view and edit them with every F7cloud client. Furthermore, a separate REST API allows for an easy integration into apps (Android, iOS, as well as 3rd-party apps which allow convenient access to your F7cloud notes). Further features include marking notes as favorites.

🚀 Installation

In your F7cloud, simply navigate to »Apps«, choose the category »Office«, find the Notes app and enable it. Then open the Notes app from the app menu.

F7cloud will notify you about possible updates. Please have a look at CHANGELOG.md for details about changes.

❗ Bugs

Before reporting bugs:

• get the newest version of the Notes app
• please consider also installing the latest development version
• check if they have already been reported

👥 Maintainers

• Kristof Hamann
• Hendrik Leppelsack (formerly)
• Lukas Reschke (formerly)

⚠️ Developer Info

Building the app

1. Clone this into your apps folder of your F7cloud
2. In a terminal, run the command make dev-setup to install the dependencies
3. Then to build the Javascript run make build-js or make watch-js to rebuild it when you make changes
4. Enable the app through the app management of your F7cloud

REST API for third-party apps

The notes app provides a JSON-API for third-party apps. Please have a look at our API documentation.

Admin configuration

It is possible to specify different defaults for the notes settings of new users using occ commands like these:

occ config:app:set notes noteMode --value="preview"
occ config:app:set notes fileSuffix --value=".md"
occ config:app:set notes defaultFolder --value="Shared notes"

Setting	Property name	Default	Other available option(s)
Display mode for notes	noteMode	edit	preview
File extension for new notes	fileSuffix	.txt	.md
Folder to store your notes	defaultFolder	Notes	Custom