lambchopinc / kms Goto Github PK

KMS is a modern and flexible Ruby on Rails content management system with modular approach. It utilizes the most latest features from Rails and PostgreSQL (such as json column type, for example). Mostly inspired by LocomotiveCMS, but in contrast with it KMS relies on robust PostgreSQL database and doesn't provide all-in-one solution. The basic idea behind KMS: minimal core, extendable via extensions (engines). So you can take only what you need.

We, at @webgradus, used this CMS for our clients needs over past 1 year and now it's ready to be open sourced. So feel free to use it in your projects.

• Ruby on Rails (>= 4.2, Rails 5 supported as well)
• Angular.js
• Responsive Dashboard template
• Liquor template language
• PostgreSQL (recommended for DB)

• Minimal basis/core - Templates, Pages, Assets and Snippets
• Extendable via Rails Engines
• Beautiful and responsive admin panel
• Simple and Powerful Template language - Liquor
• Built-in documentation/help

1. Add to Gemfile

    gem "kms"
    # or for edge version:
    gem "kms", github: "webgradus/kms"
   

2. Setup database.yml (only PostgreSQL 9.2+ supported)

3. Run generator:

    rails g kms:install
   

4. Copy migrations:

    rails kms:install:migrations
   

5. Migrate:

    rails db:migrate
   

6. Set locale in your main app.

7. Precompile assets (if it will be production app):

    RAILS_ENV=production bundle exec rails assets:precompile
   

8. Run it using your favorite webserver - unicorn, puma, thin

9. Open your browser at http://localhost:3000/kms and sign up first admin user.

Please watch this video to start working in KMS:

• kms_models

• Make sure you have "pids" and "sockets" folders in project's "tmp" folder (if using Puma especially)