Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 5.69 KB

README.md

File metadata and controls

134 lines (87 loc) · 5.69 KB

Detailed Installation

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)

Local Development Setup

Server Side Setup

The server-side of RC4Conferences comprises of Eventyay's Open Event Server Docker Image, FaunaDB development Docker Image, and Strapi CMS. To start all of the services simulataneously, please run the following,

sh startdevenv.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

The above script shall execute successfully and open up 5 ports

  • 8080
  • 8443
  • 8444
  • 8084
  • Random port for Strapi (defaults to 1337)

In case of any error output while script is executing, please rectify them, or else open a new issue, the community shall help you at earliest.

You have successfully setup the backend of RC4Conferences, now please move forward 🚀 to setting up the client-side.

Client Side Setup

The client-side of RC4Conferences is developed using NextJS, to start the development environment of NextJS please run the following,

sh startNext.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

On a successful execution of script, the NextJS will start on port 3000 (default) or if it is occupied the next available port shall be used e.g., 3001.

Congratulations! 🎉 You have successfully setup both the Client-Side and Server-Side.

fun-try: You can press period . key to open up VS code style code reader on any GitHub repository.

Gitpod Development Setup

To start the development on Gitpod, click on the button "Open in Gitpod"

Open in Gitpod

Server-side setup

Same as mentioned in the Local Development Server-side setup

Client-side setup

The client-side of RC4Conferences is developed using NextJS, to start the development environment of NextJS please run the following,

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

On a successful execution of script, the NextJS will start on port 3000 (default) or if it is occupied the next available port shall be used e.g., 3001.

Congratulations! 🎉 You have successfully setup both the Client-Side and Server-Side.

Day of Event Setup (Optional)

For setting up the Greenroom and Mainstage Page components, please read this.

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

Fun try: Try refreshing the /conferences page. (Hint: Background image)