Skip to content

faq

Jump to bottom
Artur edited this page May 14, 2024 · 1 revision

Why another app for working with org format?

Well, in short, I wasn’t satisfied with existing solutions. I wanted to bring the full power of using Emacs for note-taking to mobile devices. The final version of the app will support the following features:

  • Seamless synchronization of notes with Emacs through various types of providers
  • Data encryption
  • Extension mechanism
  • User-friendly interface
  • Support for literate programming through various org-babel providers, allowing code execution through third-party providers
  • Use of notifications to work with org-agenda
  • Ability to publish notes in blog format, as well as share notes via links with colleagues and friends.

What technology stack is used in the project?

Client side:

Backend:

Why JavaScript and not Flutter/QT/something else?

The choice of stack was primarily determined by the speed at which I could complete the project. It’s not the perfect stack, but sufficient to get a well-functioning product working on all platforms.

Is Markdown integration planned?

No.

Are my data secure?

Currently, it’s possible to enable end-to-end encryption using PGP.

Is org-roam mandatory? Or can I use regular org files?

You can use regular org files, but you need to have an :ID: property!

Is there any support planned for *.org.gpg files?

Yes!

Can I use my own server?

Sure! But there is no documentation right now. If someone can help with this, I would be very grateful!

Can I lose my notes?

Yes. Despite the presence of migrations for updates in the project, there is currently no backup server. I postponed its support for several reasons:

  • It requires additional financial resources
  • The project is in the beta testing stage.

So please, make backups of your notes.*

Will synchronization from the file system be available?

Yes. This is one of the key tasks at the moment. I plan to add a special API that will have access to the file system. Through this API, it will be possible to write extensions for synchronization via the file system as well as through other sources.

Will synchronization through GitLab/GitHub/Dropbox, etc. be available?

There won’t be native synchronization. But third-party developers will be able to use the API to write extensions, which will allow notes to be synchronized through any source.

Will the app be published on F-Droid?

Yes. After the first stable version is released for synchronization of notes through the file system.

Will there be an iOS version?

Yes. Immediately after implementing the API for synchronizing notes through the file system.

What are the plans for implementing new features?

The current roadmap looks as follows:

  • [x] Dashboard
  • [x] Bookmarks
  • [x] Implementation of a public API for extension development
  • [x] E2E data encryption
  • [ ] Publishing notes through Server side rendering
  • [ ] API for working with the file system and note synchronization
  • [ ] Changes to internal APIs for command-based operations
  • [ ] Migration to a virtual file system for working with org files.
  • [ ] F-Droid publication
  • [ ] Adaptation for iOS
  • [ ] AppStore publication
  • [ ] WebSockets
  • [ ] *.org.gpg support
  • [ ] Creating infrastructure for storing notes on the server
  • [ ] API for working with org-babel
  • [ ] Ability to publish notes and entire directories as a blog
  • [ ] Agenda and notifications
  • [ ] CRDT for better note synchronization (under consideration)

Priority may change depending on user feedback. You can influence feature priorities through Patreon.

How can I contribute to the project?

I will be grateful for any help; in general, this project requires quite a lot of effort, unfortunately, not just programming. You can:

  • Create a pull request to fix a bug or add a new feature
  • Help with documentation
  • Support the project financially, through Patreon, cryptocurrency, or PayPal.
  • Create videos describing new features.
  • Moderate the Discord channel
  • Help with testing. Perhaps this point is currently the most important.
  • Design system development. I’m not a designer, and I have to do many things several times, so if you have the time and desire, I will be very grateful for help in this aspect.

Clone this wiki locally