Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.27 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.27 KB

Leaflet

POSP official notes application, written in flutter, beautiful, fast and secure.

Get it on Google Play

Main features

  • Material design
  • Completely cross platform
  • List/grid view for notes
  • Multiple note extras, such as lists, images and drawings
  • Lock notes with a pin or password or biometrics
  • Hide notes content on the main page
  • Search notes with various filters
  • Complete theme personalization
  • Local backup/restore functionality with encryption
  • Trash and archive for notes
  • Database encryption
  • Tags for notes

Planned features

  • New sync api integration
  • Folders
  • Refined UI for desktop platforms

Compiling the app

Before anything, be sure to have a working flutter sdk setup.

Be sure to disable signing on build.gradle or change keystore to sign the app.

For now the required flutter channel is master, so issue those two commands before starting building:

~$ flutter channel master
~$ flutter upgrade

After that, building is simple as this:

~$ flutter pub get

~$ flutter run           # for debug
~$ flutter build apk --flavor dev     # release build with dev flavor (available flavors are dev, production and ci)

Generating locales

After adding or updating the locales, run the following command from Leaflet root dir:

dart bin/locale_gen.dart

This will generate and update the required files

Contributing

The entire app and even the online sync api is completely open source.
Feel free to open a PR to suggest fixes, features or whatever you want, just remember that PRs are subjected to manual review so you gotta wait for actual people to look at your contributions

For translations, head over to our Crowdin.

If you want to receive the latest news head over to our Telegram channel, if you want to chat we even got the Telegram group.