lino.jorzick/greenlight
1
0
Fork 0
forked from External/greenlight
Code Issues Pull Requests Projects Releases Wiki Activity

add readme

Browse Source
This commit is contained in:
Josh
2018-06-13 16:33:23 -04:00
parent bc67d9e1e5
commit 37d9ae4136
3 changed files with 28 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,24 +1,36 @@
# README
# Greenlight
This README would normally document whatever steps are necessary to get the
application up and running.
Greenlight is a simple front-end interface for your BigBlueButton server. At it's heart, Greenlight provides a minimalistic web-based application that allows users to:
Things you may want to cover:
* Signup/Login with Twitter, Google, or through the application itself.
* Manage your account settings and user preferences.
* Create and manage your own personal rooms ([BigBlueButton](https://github.com/bigbluebutton/bigbluebutton) sessions).
* Invite others to your room using a simple URL.
* View recordings and share them with others.
* Ruby version
Furthermore, Greenlight is completely configurable. This means you can turn on/off features to make Greenlight fit your specific use case. For more information on this, see our [documentation](http://docs.bigbluebutton.org/install/green-light.html).
* System dependencies
For a overview of how GreenLight works, checkout our introduction to Greenlight video:
* Configuration
[![GreenLight Overview](https://img.youtube.com/vi/yGX3JCv7OVM/0.jpg)](https://youtu.be/yGX3JCv7OVM)
* Database creation
* Database initialization
## Installation on a BigBlueButton Server
* How to run the test suite
Greenlight is designed to work on a [BigBlueButton 2.0](https://github.com/bigbluebutton/bigbluebutton) (or later) server.
* Services (job queues, cache servers, search engines, etc.)
### Using Docker (recommended)
* Deployment instructions
* ...
### Without Docker
## Source Code
GreenLight is built using Ruby on Rails. Many developers already know Rails well, and we wanted to create both a full front-end to BigBlueButton but also a reference implementation of how to fully leverage the [BigBlueButton API](http://docs.bigbluebutton.org/dev/api.html).
We invite you to build upon GreenLight and help make it better. See [Contributing to BigBlueButton](http://docs.bigbluebutton.org/support/faq.html#contributing-to-bigbluebutton).
We invite your feedback, questions, and suggests about GreenLight too. Please post them to the [developer mailing list](https://groups.google.com/forum/#!forum/bigbluebutton-dev).