feat: reduce number of steps needed to get going for local development (

#454) * feat: reduce number of steps to get going for local development * fix: set default sync server in SNJS * chore: keep --force in submodules command
standardnotes · Sep 2, 2020 · 57aa942 · 57aa942
1 parent 6a1c10d
commit 57aa942
Show file tree

Hide file tree

Showing 11 changed files with 448 additions and 24 deletions.
diff --git a/.env.sample b/.env.sample
@@ -12,3 +12,8 @@ SF_DEFAULT_SERVER=http://localhost:3000
 
 # Datadog
 DATADOG_ENABLED=false
+
+# Development options
+DEV_DEFAULT_SYNC_SERVER=https://sync.standardnotes.org
+DEV_EXTENSIONS_MANAGER_LOCATION=public/extensions/extensions-manager/dist/index.html
+DEV_BATCH_MANAGER_LOCATION=public/extensions/batch-manager/dist/index.min.html
diff --git a/.gitignore b/.gitignore
@@ -28,8 +28,6 @@
 
 dump.rdb
 
-index.html
-
 # Ignore compiled assets
 /public/assets
 
@@ -42,4 +40,4 @@ index.html
 # Generated Files
 /dist/javascripts
 /dist/stylesheets
-/dist/fonts
+/dist/fonts
diff --git a/README.md b/README.md
@@ -89,10 +89,7 @@ This repo contains the core code used in the web app, as well as the Electron-ba
 **Instructions:**
 
 1. Clone the repo
-1. `bundle install`
-1. `npm install`
-1. `bundle exec rails assets:precompile`
-1. `cp index.html.sample index.html`
+1. `npm run setup`
 1. `npm start`
 
 Then open your browser to `http://localhost:3001`.

diff --git a/app/assets/javascripts/app.ts b/app/assets/javascripts/app.ts
@@ -54,19 +54,26 @@ import { isDev } from './utils';
 import { Bridge, BrowserBridge } from './services/bridge';
 
 if (__WEB__) {
-  startApplication(new BrowserBridge());
+  startApplication(
+    (window as any)._default_sync_server,
+    new BrowserBridge()
+  );
 } else {
   (window as any).startApplication = startApplication;
 }
 
-function startApplication(bridge: Bridge) {
+function startApplication(
+  defaultSyncServerHost: string,
+  bridge: Bridge
+) {
   angular.module('app', ['ngSanitize']);
 
   // Config
   angular
     .module('app')
     .config(configRoutes)
     .constant('bridge', bridge)
+    .constant('defaultSyncServerHost', defaultSyncServerHost)
     .constant('appVersion', __VERSION__);
 
   // Controllers

diff --git a/app/assets/javascripts/ui_models/application.ts b/app/assets/javascripts/ui_models/application.ts
@@ -56,6 +56,7 @@ export class WebApplication extends SNApplication {
     $timeout: ng.ITimeoutService,
     scope: ng.IScope,
     onDeinit: (app: WebApplication) => void,
+    defaultSyncServerHost: string,
     bridge: Bridge,
   ) {
     const namespace = '';
@@ -73,6 +74,7 @@ export class WebApplication extends SNApplication {
       namespace,
       undefined,
       undefined,
+      defaultSyncServerHost
     );
     this.$compile = $compile;
     this.scope = scope;

diff --git a/app/assets/javascripts/ui_models/application_group.ts b/app/assets/javascripts/ui_models/application_group.ts
@@ -29,7 +29,8 @@ export class ApplicationGroup {
     $compile: ng.ICompileService,
     $rootScope: ng.IRootScopeService,
     $timeout: ng.ITimeoutService,
-    private bridge: Bridge
+    private defaultSyncServerHost: string,
+    private bridge: Bridge,
   ) {
     this.$compile = $compile;
     this.$timeout = $timeout;
@@ -71,7 +72,8 @@ export class ApplicationGroup {
       this.$timeout,
       scope,
       this.onApplicationDeinit,
-      this.bridge
+      this.defaultSyncServerHost,
+      this.bridge,
     );
     const appState = new AppState(
       this.$rootScope,

diff --git a/index.html.sample → index.html b/index.html.sample → index.html
@@ -26,19 +26,18 @@
   <meta ng-bind="title" content="Standard Notes" name="application-name" />
 
   <title>Dev · Notes · Standard Notes</title>
+</head>
 
+<body
+  data-default-sync-server="<%= env.DEV_DEFAULT_SYNC_SERVER %>"
+  data-extensions-manager-location="<%= env.DEV_EXTENSIONS_MANAGER_LOCATION %>"
+  data-batch-manager-location="<%= env.DEV_BATCH_MANAGER_LOCATION %>"
+>
   <script>
-    window._default_sync_server = "https://sync.standardnotes.org";
-    window._extensions_manager_location = "public/extensions/extensions-manager/dist/index.html";
-    window._batch_manager_location = "public/extensions/batch-manager/dist/index.min.html";
+    window._default_sync_server = document.body.dataset.defaultSyncServer || "https://sync.standardnotes.org";
+    window._extensions_manager_location = document.body.dataset.extensionsManagerLocation || "public/extensions/extensions-manager/dist/index.html";
+    window._batch_manager_location = document.body.dataset.batchManagerLocation || "public/extensions/batch-manager/dist/index.min.html";
   </script>
-
-  <script src="/dist/javascripts/app.js"></script>
-  <link rel="stylesheet" media="all" href="/dist/stylesheets/app.css" debug="false" />
-
-</head>
-
-<body>
   <application-group-view />
 </body>