README.rdoc in bjond-api-1.0.0 vs README.rdoc in bjond-api-1.1.0
- old
+ new
@@ -47,18 +47,30 @@
In application.js, include scripts using -
//= require bjond-api
+Also, remove references to turbolinks.
+
From your angular app, include our module as a dependency -
angular.module('your-app',['bjond-api']);
+From application.css, require the core css:
+
+ *= require 'bjond_registrations'
+
- (5b) The generator will also create a root config create a config file that will initialize important variables for the Bjond-App gem. This will be copied into your app at: config/initializers/bjond-api-initializer.rb
-(6) Set-up Encryption Key
+(6) The angular / css can be loaded by using the following code in the application.html.erb:
+ <div class="bjond-application" ng-app="bjond-app">
+ <%= yield %>
+ </div>
+
+(7) Set-up Encryption Key
+
For security, the encryption keys stored from Bjond Server are themselves encrypted. Define the following environment variable: APP_ENCRYPTION_KEY. If you have multiple apps in your environment, you can modify the name of this constant using BjondApi::BjondAppConfig.instance.encryption_key_name.
To create an API key, from the Rails console (Rails c), type -
[ Array.new(32) { rand(256) }.pack('C*') ].pack('m').chop
@@ -75,10 +87,18 @@
and
BJOND_ADAPTER_AUDIENCE
+(8) Set URL Options. In `development.rb`, set your local development options:
+
+ config.action_controller.default_url_options = {
+ :host => "localhost:3002",
+ :root_url => "http://localhost:3002"
+ }
+
+
== Routes
This gem contains several prepared routes that will aid registration, and communication with Bjond Server core.
To set your app's default route to the registration page, add this line to your routes.rb file -
@@ -98,6 +118,10 @@
== Environment Variables
- BJOND_ADAPTER_AUDIENCE
- BJOND_ADAPTER_SUBJECT
+== Essential Schema
+https://user-images.githubusercontent.com/868768/27399560-2d0fe7fc-568b-11e7-8762-49f2cd24ac96.jpg
+
+Most likely, your app schema will have additional configuration tables that are specific to the business logic of the adapter.
\ No newline at end of file