Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Latest commit

 

History

History
67 lines (46 loc) · 2.87 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.87 KB
Raw

Forest Rails Liana Build Status

The official Rails liana for Forest. Forest is a modern admin interface (see the live demo) that works on all major web frameworks. forest_liana is the gem that makes Forest admin work on any Rails application (Rails >= 4.0).

Installation

Visit Forest's website, enter your email and click "Get started".
You will then follow a 4-step process (also available in this 1 min video):

  1. Choose your stack (Rails)
  2. Install Forest Liana
## Add to your application's Gemfile
gem 'forest_liana'

## Bundle it
bundle install

## Install it with the provided environment secret
rails g forest_liana:install FOREST-ENV-SECRET
  1. Get your app running, provide your application URL and check if you have successfully installed Forest Liana on your app.
  2. Choose your credentials, log into https://app.forestadmin.com and start customizing your admin interface! 🎉

NOTE: If you’re stuck, can’t get something working or need some help, feel free to contact the Forest team at [email protected]

How it works

Installing forest_liana into your app will automatically generate an admin REST API for your app.
This API allows the Forest admin UI to communicate with your app and operate on your data.
Note that data from your app will never reach Forest's servers. Only your UI configuration is saved.
As this gem is open-source, you're free to extend the admin REST API for any operation specific to your app.

Integrations

One core concept of Forest is to bring all your data back into one single admin interface. Forest integrates with the 3rd party services / SaaS you already use and allow you to manage all your operations from one place.

Check out our documentation about integrations: https://doc.forestadmin.com/developer-guide/rails.html#integrations

Documentation

Complete documentation is available at https://doc.forestadmin.com/developer-guide/rails.html

How to contribute

This liana is officially maintained by Forest.
We're always happy to get contributions for other fellow lumberjacks.
All contributions will be reviewed by Forest's team before being merged into master.

Here is the contribution workflow:

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

Please ensure that the tests are passing before submitting any pull request:

$ RAILS_ENV=test bundle exec rake --trace db:migrate test

Licence

GPL v3