Table of Contents

1. Flowcation
2. This is pre-alpha. Don't use just yet :)
   1. Installation
      1. Prerequisites
      2. Basic
      3. Bundler
      4. Rails
   2. Usage
   3. Development
   4. Contributing
   5. License
   6. Code of Conduct

Flowcation

This is pre-alpha. Don't use just yet :)

Generate Views from static Html.
Flowcation enables Designers to work on a rails apps layout without installing ruby and rails locally.
This is also useful for Themes purchased from a marketplace like themeforest.
The time-consuming integration can be almost entirely omitted.
The one-off effort of mapping layouts, templates, partials and subtitutions via xpath declarations allows to transfer further, at least minor, changes automatically.

Installation

Prerequisites

Flowcation depends on Nokogiri (1.8.2) and ActiveSupport.

Basic

$ gem install flowcation

Bundler

Add this line to your application's Gemfile:

gem 'flowcation'

And then execute:

$ bundle

Rails

After installing via Bundler, execute

$ rails g flowcation:install

This creates a folder 'flowcation' inside the config with a barebone rails.yml file.

Usage

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mhennemeyer/flowcation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Flowcation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.