Sha256: fb7ba8bec7311cf039424c0d6bed1ffb329333d4bbd2178650a92da20b0fb5b5
Contents?: true
Size: 1.98 KB
Versions: 20
Compression:
Stored size: 1.98 KB
Contents
# Steam
[](https://codeclimate.com/github/locomotivecms/steam) [](https://gemnasium.com/locomotivecms/steam) [](https://travis-ci.org/locomotivecms/steam) [](https://coveralls.io/r/locomotivecms/steam?branch=master) [](https://gitter.im/locomotivecms/steam)
The rendering stack used by both Wagon and Engine (WIP). It includes:
- the rack stack to serve assets (SCSS, Coffeescript, ...etc) and pages.
- the liquid drops/filters/tags libs to parse and render liquid templates.
- a Filesystem adapter which reads the source of a site written for Wagon.
- a MongoDB adapter which reads an existing site hosted by the Locomotive Engine.
**Note:** Steam passes all the specifications of both Wagon and Engine.
## Installation [WIP]
gem install thin
gem install locomotivecms_steam --pre
## Usage
### Command line:
Display all the options:
steam --help
Render a local Wagon site:
steam --path=<PATH to a Wagon site>
Render a Engine site:
steam --database=<NAME of the MongoDB database used by the Engine> --assets-path=<PATH to the public folder of the Locomotive>
Once launched, open your browser
open localhost:8080
### Inside a Rails application:
[TODO]
## TODO
see the list in the issues section.
## Contributing
1. Fork it ( http://github.com/<my-github-username>/locomotivecms/steam )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## License
Copyright (c) 2015 NoCoffee. MIT Licensed, see LICENSE for details.
Version data entries
20 entries across 20 versions & 1 rubygems