From 37d9ae4136e406c2a43aea8580e8dff743f3c786 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 13 Jun 2018 16:33:23 -0400 Subject: [PATCH] add readme --- README.md | 38 ++++++++++++------- app/controllers/rooms_controller.rb | 2 + .../shared/components/_room_block.html.erb | 2 +- 3 files changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7db80e4c..66979a17 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/app/controllers/rooms_controller.rb b/app/controllers/rooms_controller.rb index d7b8b301..c1cd7a7c 100644 --- a/app/controllers/rooms_controller.rb +++ b/app/controllers/rooms_controller.rb @@ -7,6 +7,8 @@ class RoomsController < ApplicationController # POST /r def create + redirect_to root_path unless current_user + @room = Room.new(name: room_params[:name]) @room.owner = current_user diff --git a/app/views/shared/components/_room_block.html.erb b/app/views/shared/components/_room_block.html.erb index ba8f5d15..93c24bd9 100644 --- a/app/views/shared/components/_room_block.html.erb +++ b/app/views/shared/components/_room_block.html.erb @@ -25,7 +25,7 @@