Gem Version Current Build Status Inline docs

Integral CMS

Integral CMS Features

Integral is a CMS for Rails 5+. The aim of Integral is to lower the barrier of entry in creating websites, using Ruby on Rails, with all the bells and whistles that users have now come to expect. Out of the box integral provides;

  • Backend features
    • Professional design
    • User authentication & authorization
    • Page & Post management with full WYSWIYG editing
    • Image management (w/ background image processing)
    • List management
    • Settings management
    • Activity tracking
  • Frontend features
    • Dynamic Pages
    • Integrated Blog
    • SEO Ready
    • Contact form processing w/ HTML emails
    • Sitemap generation
  • Find out more...

Demo Now - Deploy a Sample App

Deploy

Getting Started

  1. Create a new Rails application rails new example_app --database=postgresql -T
  2. Add Integral to your Gemfile and run bundle install gem 'integral'
  3. Run Integral install rake task (adds configuration initializers, installs routes & sets up database) rails generate integral:install
  4. Set the default host within the development environment, used for URL generation ``` # config/environments/development.rb

Rails.application.routes.default_url_options[:host] = 'http://localhost:3000'


Voila! Start your rails server and you're ready to go! You can access the user only area at `/admin`

Integral requires Rails 5.1 or higher and Ruby 2.4.1 or higher.

## Information

* [Integral Website][integral-cms]
* [CHANGELOG](https://github.com/yamasolutions/integral/blob/master/CHANGELOG.md)
* [Code Documentation][docs-website]
* [Wish list](https://github.com/yamasolutions/integral/wiki/Wish-List)

### Guides
* [Deploying to production](https://github.com/yamasolutions/integral/blob/master/docs/deploying_to_production.md)
* [Integral <3 Heroku](https://github.com/yamasolutions/integral/blob/master/docs/heroku.md)
* [Extending Integral](https://github.com/yamasolutions/integral/blob/master/docs/extending_integral.md)
* [Integral Lists](https://github.com/yamasolutions/integral/blob/master/docs/integral_lists.md)
* [Integral Pages](https://github.com/yamasolutions/integral/blob/master/docs/integral_pages.md)
* [Integral Widgets](https://github.com/yamasolutions/integral/blob/master/docs/integral_widgets.md)
* [WYSIWYG Editor](https://github.com/yamasolutions/integral/blob/master/docs/wysiwyg_editor.md)

### Bug reporting
If you discover a problem with Integral, we would love to know about it. Please use the [GitHub issue tracker][github-issue-tracker] to contact us about it.

If you have discovered a security related bug, please do NOT use the GitHub issue tracker. Send an email to [email protected]


### Looking for help
If you have any questions please use [StackOverflow](https://stackoverflow.com) instead of the GitHub issue tracker.


## Contributing
We love contributers! Please check out the [contributing guide][contributing-guide] for guidelines on how to proceed. Bug reports and pull requests are welcome on [Github][integral-github].


## Licence
Integral is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).