README.md

Releaf

Releaf is Admin interface for Rails projects.

Changelog: https://github.com/cubesystems/releaf/blob/master/CHANGELOG.md

Getting started

Releaf works with Rails 6.1 and Ruby 3

First add Releaf gem to your Gemfile

gem 'releaf', '~> 2.1'

Run the bundle command to install it.

Then install with

rails generate releaf:install
rake db:migrate

You might want to create default role and user

rake db:seed

Now you need to add something like this for releaf itself and standart admin, permissions controllers

mount_releaf_at '/admin'

Note that you should re-start your app here if you've already started it. Otherwise you'll run into strange errors.

Now open "/admin" on your dev site and login with following credentials:

email: [email protected]
password: password

Testing

Setup

Create config.yml (see examples in git root) and run

rake dummy:setup

Running rspec

rspec .

or

rake ci

Cleanup

rake dummy:remove

New version releasing

1. bump version in lib/releaf/version.rb
2. write all changes and new version number in CHANGELOG.md
3. commit previous changes
4. create git version tag ex: v1.0.12
5. run rake gem:build && rake gem:push  
6. push new tag with git push --tags