Add doc standalone extension in your Rails Application

refinery · Apr 14, 2016 · 923be7c · 923be7c
1 parent 7dfbb47
commit 923be7c
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 0 deletions.
diff --git a/...a Refinery CMS extension as a standalone extension in your Rails Application.md b/...a Refinery CMS extension as a standalone extension in your Rails Application.md
@@ -0,0 +1,39 @@
+## Using a Refinery CMS extension as a standalone extension in your Rails Application
+
+A Refinery CMS extension can be used as a standalone extension in your Rails application.
+
+This guide will show you how to:
+* Bootstrap a rails application with just the use of a Refinery CMS extension like +refinerycms-blog+
+
+### Bootstrap a rails app with just the use of a Refinery CMS extension like +refinerycms-blog+
+
+First, bootstrap a new rails application:
+
+```ruby
+$ rails _4.2.6_ new blog_test_app
+```
+
+Put just the +refinerycms-blog+ in your project's Gemfile:
+
+```ruby
+$ gem "refinerycms-blog", git: "https://github.com/refinery/refinerycms-blog"
+```
+
+This will merely pull in `refinerycms-core` and `refinerycms-settings` based on the current gemspec dependencies.
+
+Then you can run:
+
+```ruby
+$ bundle install
+$ rails generate refinery:cms
+```
+
+And all the other normal set up tasks like migrations.
+
+Now, you should have a Rails app with _only_ the Refinery CMS Blog.
+
+Finally, start your application and enjoy the use of Refinery CMS Blog only:
+
+```ruby
+$ rails server
+```
diff --git a/...inery CMS extension as a standalone extension in your Rails Application.textile b/...inery CMS extension as a standalone extension in your Rails Application.textile
@@ -0,0 +1,41 @@
+h2. Using a Refinery CMS extension as a standalone extension in your Rails Application
+
+A Refinery CMS extension can be used as a standalone extension in your Rails application.
+
+This guide will show you how to:
+* Bootstrap a rails application with just the use of a Refinery CMS extension like +refinerycms-blog+
+
+endprologue.
+
+h3. Bootstrap a rails app with just the use of a Refinery CMS extension like +refinerycms-blog+
+
+First, bootstrap a new rails application:
+
+<ruby>
+$ rails _4.2.6_ new blog_test_app
+</ruby>
+
+Put just the +refinerycms-blog+ in your project's Gemfile:
+
+<ruby>
+$ gem "refinerycms-blog", git: "https://github.com/refinery/refinerycms-blog"
+</ruby>
+
+This will merely pull in +refinerycms-core+ and +refinerycms-settings+ based on the current gemspec dependencies.
+
+Then you can run:
+
+<ruby>
+$ bundle install
+$ rails generate refinery:cms
+</ruby>
+
+And all the other normal set up tasks like migrations.
+
+Now, you should have a Rails app with _only_ the Refinery CMS Blog.
+
+Finally, start your application and enjoy the use of Refinery CMS Blog only:
+
+<ruby>
+$ rails server
+</ruby>