clean up docs

1 files changed, 91 insertions, 0 deletions

diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md
new file mode 100644
index 0000000..991218e
--- /dev/null
+++ b/doc/DEVELOP.md
@@ -0,0 +1,91 @@
+# Development #
+
+## Continuous Integration ##
+
+See https://travis-ci.org/leapcode/leap_web for CI reports.
+
+## Views ##
+
+Some tips on modifying the views:
+
+* Many of the forms use [simple_form gem](https://github.com/plataformatec/simple_form)
+* We still use client_side_validations for the validation code but since it is not maintained anymore we want to drop it asap.
+
+## Engines ##
+
+Leap Web contains some. They live in their own subdirectory and are included through bundler via their path. This way changes to the engines immediately affect the server as if they were in the main `app` directory.
+
+Currently Leap Web includes 2 Engines:
+
+* [support](https://github.com/leapcode/leap_web/blob/master/engines/support) - Help ticket management
+* [billing](https://github.com/leapcode/leap_web/blob/master/engines/billing) - Billing System
+
+## Creating a new engine ##
+
+If you want to add functionality to the webapp but keep it easy to remove you might consider adding an engine. This only makes sense if your engine really is a plugin - so no other pieces of code depend on it.
+
+### Rails plugin new ###
+
+Create the basic tree structure for an engine using
+```
+rails plugin new ENGINE_NAME -O --full
+```
+
+`-O` will skip active record and not add a dev dependency on sqlite.
+`-full` will create a directory structure with config/routes and app and a basic engine file.
+
+See http://guides.rubyonrails.org/engines.html for more general info about engines.
+
+You need to require engine specific gems in lib/my_engine/engine.rb:
+
+```ruby
+require "my_dependency"
+
+module MyEngine
+  class Engine < ::Rails::Engine
+    # ...
+  end
+end
+```
+
+## Creating Models ##
+
+You can use the normal rails generators to create models. You probably want to require couchrest_model so your models inherit from CouchRest::Model::Base.
+http://www.couchrest.info/model/definition.html has some good first steps for setting up the model.
+CouchRest Model behaved strangely when using a model without a design block. So make sure to define an initial view: http://www.couchrest.info/model/view_objects.html .
+
+From that point on you should be able to use the standart persistance and querying methods such as create, find, destroy and so on.
+
+## Writing Tests ##
+
+### Locale
+
+The ApplicationController defines a before filter #set_locale that will set
+the default_url_options to include the appropriate default {:locale => x} param.
+
+However, paths generated in tests don't use default_url_options. This can
+create failures for certain nested routes unless you explicitly provide
+:locale => nil to the path helper. This is not needed for actual path code in
+the controllers or views, only when generating paths in tests.
+
+For example:
+
+    test "robot" do
+      login_as @user
+      visit robot_path(@robot, :locale => nil)
+    end
+
+## Debugging
+
+Sometimes bugs only show up when deployed to the live production server. Debugging can be tricky,
+because the open source mod_passenger does not support debugger. You can't just run
+`rails server` because HSTS records for your site will make most browsers require TLS.
+
+One solution is to temporarily modify the apache config to proxypass the TLS requests to rails:
+
+    <virtualhost *:443>
+      ProxyPass / http://127.0.0.1:3000/
+      ProxyPassReverse / http://127.0.0.1:3000/
+      ProxyPreserveHost on
+      ....
+    </virtualhost>
\ No newline at end of file