denny/ShinyCMS-ruby

View on GitHub
plugins/ShinyAccess/README.md

Summary

Maintainability
Test Coverage
# ShinyAccess: an access control plugin for ShinyCMS

ShinyAccess is a plugin for [ShinyCMS](https://shinycms.org) which adds access control features to your ShinyCMS website.


## Installation

Add 'ShinyAccess' to the SHINYCMS_PLUGINS ENV var, then run`bundle install` for your main ShinyCMS app.

(Currently, all plugins are enabled by default, so you don't actually need to set the ENV var unless you want to load a subset of plugins.

To add the ShinyAccess tables and supporting data to your ShinyCMS database:
```bash
rails shiny_access:install:migrations
rails db:migrate
rails shiny_access:db:seed
```


## Contributing

See the ShinyCMS developer documentation for information on contributing to this plugin or any other part of the ShinyCMS project.

Please read the Code of Conduct as well.


## Copyright and Licensing

ShinyCMS is copyright 2009-2021 Denny de la Haye https://denny.me

This ShinyCMS plugin is free software; you can redistribute it and/or modify it under the terms of the GPL (version 2 or later). You should have copies of both v2 and v2 of the GPL in your ShinyCMS docs folder, or you can read them online: https://opensource.org/licenses/gpl-2.0 / https://opensource.org/licenses/gpl-3.0