wix-incubator / wix-rails-rss-feed-app

RSS Feed App - (Ruby on Rails)

About

A Wix App, RSS Feed, demonstrating how to build a production ready app. Client & Server from scratch using Ruby on Rails server & Wix client side libraries.

Click here for demo live sample.

Intro

This is app is built using the same structure and concepts as the RSS Feed on Google App Engine but uses Ruby on Rails as it's backend. The client side (html/js/css) is identical.

This project is set to work on your local dev machine using rails WEBrick server and a local sqlite3 database.

Overview

This app was developed using the rails scaffolder, so the directory structure is rails classic. We made the following changes:

  |-- README.md
  |-- app
  |   |-- controllers
  |   |   `-- app_controller.rb         (New)
  |   |-- models
  |   |   `-- settings.rb               (New)
  |   `-- views
  |       `-- app
  |           |-- settings.html.erb     (New)
  |           `-- widget.html.erb       (New)
  |-- config
  |   |-- application.rb                (wix-apps middleware setup - your app secret goes here)  
  |   `-- routes.rb                     (Added routes)
  |-- public                            (All New)
  |   |-- 404.html
  |   |-- 500.html
  |   |-- help.html
  |   |-- error-view.html
  |   |-- invalid-instance.html
  |   |-- css
  |   |-- js
  |   |-- external_modules
  |   `-- wix-ui-lib
  |-- Gemfile                           (Added the wix-apps gem)

As all other app samples, the app business logic resides in the client side (Javascript) under the Public folder. The server is responsible for validating that requests are arriving from the Wix platform and to store the app instance settings in a simple key-value store.

Setup

This app uses the wix-apps middleware to handle authentication, make sure you follow its setup

Run the following commands:

 bundle install

verify you have rails by running

rails --version

run DB migration

run rake db:migrate

then start the server

rails server

License

Copyright (c) 2012 Wix.com, Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.