Skip to content

Faizan-omer/RC4Conferences

 
 

Repository files navigation

RC4Conferences

Rocket Chat for Virtual Conferences a.k.a RC4Confernces (in short) is a set of scalable components for communities to build, manage, and run virtual conferences of any size. RC4Conferences extends RC4Community which is a set of tools to build and grow massive online communities with Rocket.Chat.

TL;DR try-out the project within minutes, check all the Pre-requisites, and setup following ⚡Instant Setup ~1.5 minutes.

Got questions? Or want to discuss any idea for the project, feel free to drop by and say "Hi": Rocket.Chat, Gmail

Table of Contents

Installation

Pre-requisites

  • Docker
  • Docker Compose
  • Node ~16.x.x
  • npm
  • Bash shell
  • we recommend: 8GB system memory (please use Gitpod for better resources)

Instant Setup ~1.5 minutes

To try out the project within minutes, run the following two bash commands, and you will be good to go:

Local Setup

sh startdevenv.sh localhost
sh startNext.sh localhost

Gitpod Setup

sh startdevenv.sh localhost
sh startNextGp.sh localhost

Note: Please replace the "localhost" (127.0.0.1) with your static IP if you are doing environment setup on your VM. For e.g. 173.456.1.19

Now you can try out the following:

Tried all of the above? And want to explore the project further, then please refer to this section for trying out the following:

Want more? Interested in learning in-depth installation/setup, then go ahead and read the detailed setup.

Thank you!

Usage

Create an Event

To get started with creating a Event, on the homepage first login with "Admin" role. Once successfully logged in an additional top navbar item Admin becomes available. Here is a demo walkthrough of creating a event:

event_create_with_login.-.Made.with.Clipchamp.mp4

Preview an Event

Event details can be seen on the conferenences/c/[eid] page which includes the Event poster, Event name, Event date, Event description, Event sessions, Event speakers. Please refer to the below demo walkthrough.

event_display_poster.-.Made.with.Clipchamp.mp4

Admin Dashboard - Manage Events

On the Admin dashboard all the events created by the user would be listed along with some additional options to do:

  • Add Event speakers
  • Delete Event speakers
  • Delete an Event

Here is a walkthrough demo of Admin dashboard page.

admin_event_dashboard.-.Made.with.Clipchamp.mp4

Role based access

Greenroom page is only accessible by users with a Speaker and Admin role, whereas Mainstage page is accessible by all the Admin, Speaker, and Attendee role users. Below is a walkthrough of trying out the role based access on the Greenroom page.

role_based_access.-.Made.with.Clipchamp.mp4

Greenroom and Mainstage Page

On the Day of Event, Attendees and Speakers interact through the Greenroom and Mainstage page.

Below is a walkthrough which shows how the Event Admin starts a live stream on Greenroom page, and simulataneously the broadcast is shown on the Mainstage page. Furthermore, the Speakers and Attendees share their messages using the Embedded Chat window.

Day_of_Event_Demo.-.Made.with.Clipchamp.1.mp4

Production Deployment

For deploying the RC4Conferences, you will need to create a Fauna SaaS account, please follow the instruction here for getting the Fauna (Superprofile) ready for real world usage. And add the following inside open-event-server/.env.prod.app, and replace the EVENT_USER_PASSPHRASE value to be more secure.

NEXT_PUBLIC_EVENT_ADMIN_MAIL="website admin email"

Once done, run the following commands:

sh dockernetwork.sh

sh startdevenv.sh localhost production

sh startNext.sh localhost production

Note: Please replace the "localhost" (127.0.0.1) with your static IP if you are doing environment setup on your VM. For e.g. 173.456.1.19

Additional Resources

Open Event Server custom deployment docs

Fauna Superprofile local docker custom setup docs

Fauna Superprofile SaaS custom setup docs

Details about different env files in open-event-server directory

About

A set of scalable components for communities to build, manage, and run virtual conferences of any size.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 86.3%
  • CSS 9.1%
  • Shell 4.0%
  • Other 0.6%