Skip to content
This repository has been archived by the owner on Jun 15, 2022. It is now read-only.

standardnotes/mobile

Repository files navigation

Standard Notes

Latest release version License Slack Twitter Follow

iOS & Android App

Standard Notes is a safe place for your notes, thoughts, and life's work. It focuses on being simple, so you don't have to fight with endless features that slow you down. It encrypts your notes to protect your privacy. And, it's extensible, so you can backup your notes to Dropbox, Google Drive, and other services, as well as install themes, editors, and more.

Download Options:

The Code

This is a React Native implementation of Standard Notes. React Native allows us to build native mobile applications using JavaScript. This allows us to develop faster, as well as have a more reliable and consistent cross-platform experience.

Building from source

  1. Setup your environment according to official docs and be sure you can run an example React Native project.
  2. If you would like to build the Android app, you'll need to install the Android NDK. We use native code from the Libsodium encryption library to achieve high performance. You can install the NDK inside of Android Studio. You'll need to pick the version listed here.
  3. Install yarn if you haven't already.
  4. Install project dependencies via:
yarn run init

We have two flavors of the app:

  • dev which runs connects to development syncing server. To run locally use yarn ios-dev or yarn android-dev for Android.
  • prod which is the equivalent of our production application. To run local use yarn ios-prod or yarn android-prod for Android.

If you would like to run the application on your iOS device, you'll need to do so using Xcode.

Contributing

Before contributing, please read our Longevity Statement to better understand how we approach adding new features. Unlike other projects, adding new features is something we prefer not to do, so if you have a feature which you think is absolutely essential, please create a discussion issue first before coding.