/ Notes

Open source note-taking application for Android

Open source note-taking application for Android

Omni-Notes

Note taking open-source application aimed to have both a simple interface but keeping smart behavior.

The project was inspired by the absence of such applications compatible with old phones and old versions of Android. It aims to provide an attractive look and follow the most recent design guidelines of the Google operating system.

Follow the developments and post your comments and advice on Facebook Community at https://www.facebook.com/OmniNotes

*Help to keep translations updated is always welcome, if you want give a hand checkout the translation project on https://translate.omninotes.app. *

Get it on F-Droid Get it on Google Play

Features

Currently the following functions are implemented:

  • Material Design interface
    *Basic add, modify, archive, trash and delete notes actions
  • Share, merge and search notes
  • Image, audio and generic file attachments
  • Manage your notes using tags and categories
  • To-do list
  • Sketch-note mode
  • Notes shortcut on home screen
  • Export/import notes to backup
  • Google Now integration: just tell "write a note" followed by the content
  • Multiple widgets, DashClock extension, Android 4.2 lockscreen compatibility
  • Multilanguage: 30+ languages supported: https://crowdin.com/project/omni-notes

Further developments will include:

  • Notes sychronization
  • Web interface to manage notes (stub project)

You can find a complete changelog inside the application settings menu!

If you need some help on how to use the application you'll find everything you need in the Help Online section.











User guide

Look into the wiki for GIFs-based tutorials: LINK

Build

Watch the following terminal session recording on how to compile distributable files
asciicast

To be sure that build environment is fully compliant with the project the following command creates a container with all the needed tools to compile the code:

cd {project-folder}; rm local.properties; docker rm android-omninotes; docker run -v $PWD:/workspace --name android-omninotes tabrindle/min-alpine-android-sdk:latest bash -c "yes | sdkmanager --update && yes | sdkmanager --licenses && cd /workspace && ./gradlew build --stacktrace -Dorg.gradle.daemon=true -Pandroid.useDeprecatedNdk=true"

Test

To execute all tests included into the project connect a device or emulator, then run the following command:

./gradlew testAll

Testing Pyramid

To speedup the development more levels of testing are available following the testing pyramid approach, each type test requires more time than the previous one.

Unit Tests

./gradlew --stacktrace test

Integration Tests

./gradlew --stacktrace -Pandroid.testInstrumentationRunnerArguments.notAnnotation=androidx.test.filters.LargeTest connectedAndroidTest

UI Tests

./gradlew --stacktrace -Pandroid.testInstrumentationRunnerArguments.annotation=androidx.test.filters.LargeTest connectedPlayDebugAndroidTest

Notice that in this case I specified a single flavor to run tests on. This could be a useful and faster approach when you're testing specific flavor features.

Contributing

Due to the fact that I'm using gitflow as code versioning methodology, you as developer should always start working on develop branch that contains the most recent changes.

There are many features/improvements that are not on my roadmap but someone else could decide to work on them anyway: hunt for issues tagged as Help Wanted to find them!

Feel free to add yourself to contributors.md file.

New feature or improvements contributions

This kind of contributions must have screenshots or screencast as demonstration of the new additions.

Code style

If you plan to manipulate the code then you'll have to do it by following a specific code style.
Also pay attention if you're using any plugin that automatically formats/cleans/rearrange your code and set it to only change that code that you touched and not the whole files.

Test your code contributions!

All code changes and additions must be tested.
See the related section for more informations or this two pull requests comments: one and two

Forking project

When forking the project you'll have to modify some files that are strictly dependent from my own development / build / third-party-services environment. Files that need some attention are the following:

  • gradle.properties: this is overridden by another file with the same name inside the omniNotes module. You can do the same or leave as it is, any missing property will let the app gracefully fallback on a default behavior.
  • .travis.yml: if you use TravisCI as continuous integration platform and a SonarQUBE instance for code quality analysis you'll have to modify this file according to your needs.

Code quality

A public instance of SonarQube is available both to encourage other developers to improve their code contributions (and existing code obviously) and to move the project even further into transparency and openness.

Checkout for it here

Pull requests will be automatically analyzed and rejected if they'll rise the code technical debt.

GitHub

Comments