From 75511702625c50007ee16e55f0c86a270474b796 Mon Sep 17 00:00:00 2001 From: Mo Bitar Date: Sun, 5 Aug 2018 09:42:57 -0500 Subject: [PATCH] Readme --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6daffed2c..8a3241bf1 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,31 @@ This repo contains the core code used in the web app, as well as the Electron-ba 1. `npm install` 1. `bundle exec rake bower:install` 1. `grunt` -5. `rails s` +1. `rails s` Open your browser to http://localhost:3000. +--- + +**Extensions Manager and Batch Manager:** + +The web app makes use of two optional native extensions, which can be configured to work as follows: + +1. `git submodule update --init --force --remote` (will load the submodules in the `public/extensions` folder) +1. Set the following environment variables in the .env file: + ``` + EXTENSIONS_MANAGER_LOCATION=extensions/extensions-manager/dist/index.html + BATCH_MANAGER_LOCATION=extensions/batch-manager/dist/index.min.html + ``` + +You can also set the `SF_DEFAULT_SERVER` environment variable to set the default server for login and registration. + +``` +SF_DEFAULT_SERVER=https://sync.myserver +``` + +--- + ### Other repositories: - Desktop app: https://github.com/standardnotes/desktop