diff options
| -rw-r--r-- | CUSTOM.md | 6 | ||||
| -rw-r--r-- | DEPLOY.md | 4 | ||||
| -rw-r--r-- | DEVELOP.md | 46 | ||||
| -rw-r--r-- | INSTALL.md | 6 |
4 files changed, 31 insertions, 31 deletions
@@ -1,11 +1,11 @@ # Customization # -Leap Web is based on Engines. All things in '''app''' will overwrite the default behaviour. You can either create a new rails app and include the leap_web gem or clone the leap web repository and add your customizations to the '''app''' directory. +Leap Web is based on Engines. All things in `app` will overwrite the default behaviour. You can either create a new rails app and include the leap_web gem or clone the leap web repository and add your customizations to the `app` directory. ## CSS Customization ## -We use scss. It's a superset of css3. Add your customizations to '''app/assets/stylesheets'''. +We use scss. It's a superset of css3. Add your customizations to `app/assets/stylesheets`. ## Disabling an Engine ## -If you have no use for one of the engines you can remove it from the Gemfile. Not however that your app might still need to provide some functionality for the other engines to work. For example the users engine provides '''current_user''' and other methods. +If you have no use for one of the engines you can remove it from the Gemfile. Not however that your app might still need to provide some functionality for the other engines to work. For example the users engine provides `current_user` and other methods. @@ -18,9 +18,9 @@ The following packages need to be installed: We use capistrano to deploy. We ship an example deploy.rb in config/deploy.rb.example. Edit it to match your needs. -run '''cap deploy:setup''' to create the directory structure. +run `cap deploy:setup` to create the directory structure. -run '''cap deploy''' to deploy to the server. +run `cap deploy` to deploy to the server. ## Customized Files ## @@ -1,52 +1,51 @@ -# Development # - +# Development # ## Engines ## -Leap Web consists of different Engines. 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. +Leap Web consists of different Engines. 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 consists of 4 Engines: * [core](https://github.com/leapcode/leap_web/blob/master/core) - ships some dependencies that are used accross all engines. This might be removed at some point. * [users](https://github.com/leapcode/leap_web/blob/master/users) - user registration and authorization * [certs](https://github.com/leapcode/leap_web/blob/master/certs) - Cert distribution for the EIP client -* [help](https://github.com/leapcode/leap_web/blob/master/help)- Help ticket management +* [help](https://github.com/leapcode/leap_web/blob/master/help) - Help ticket management ## Creating a new engine ## ### Rails plugin new ### Create the basic tree structure for an engine using -<code> +``` rails plugin new ENGINE_NAME -O --full -</code> +``` -'''-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. +`-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. ### Require Leap Web Core ### You need to add leap_web_core to your .gemspec: -<code> +```ruby Gem::Specification.new do |s| - ... - s.add_dependency "rails" ... + # ... + s.add_dependency "rails" s.add_dependency "leap_web_core", "~> 0.0.1" end -</code> +``` You also need to require it before you define your engine in lib/my_engine/engine.rb: -<code> +```ruby require "leap_web_core" module MyEngine class Engine < ::Rails::Engine - ... + # ... end end -</code> +``` ### Require UI Gems ### @@ -54,32 +53,33 @@ Leap Web Core provides a basic set of UI gems that should be used accross the en Do you want to add views, javascript and the like to your engine? Then you should use the common gems. In order to do so you need to add them to your gemspec: -<code> +```ruby require "my_engine/version" require "leap_web_core/dependencies" - ... + # ... Gem::Specification.new do |s| - ... - s.add_dependency "rails" ... + # ... + s.add_dependency "rails" s.add_dependency "leap_web_core", "~> 0.0.1" LeapWebCore::Dependencies.add_ui_gems_to_spec(s) end -</code> +``` You also need to require them before you define your engine in lib/my_engine/engine.rb: -<code> + +```ruby require "leap_web_core" LeapWebCore::Dependencies.require_ui_gems module MyEngine class Engine < ::Rails::Engine - ... + # ... end end -</code> +``` ## Creating Models ## @@ -15,11 +15,11 @@ For now we are using ruby 1.8.7. The following packages need to be installed: ### Gems ### -We install most gems we depend upon through [bundler](http://gembundler.com). However the bundler gem needs to be installed and the '''bundle''' command needs to be available to the user used for deploy. +We install most gems we depend upon through [bundler](http://gembundler.com). However the bundler gem needs to be installed and the `bundle` command needs to be available to the user used for deploy. ### Bundler ### -Run '''bundle install''' to install all the required gems. +Run `bundle install` to install all the required gems. ## Setup ## @@ -31,5 +31,5 @@ We also ship provider information through the webapp. For now please add your ei ## Running ## -Run '''rails server''' or whatever rack server you prefer. +Run `rails server` or whatever rack server you prefer. |