Skip to content

Latest commit

 

History

History
159 lines (110 loc) · 4.63 KB

README.md

File metadata and controls

159 lines (110 loc) · 4.63 KB
Raw

Video Events App

Overview:

The project is carried out as part of an additional course at the Faculty of Electronics of the Wrocław University of Technology.

SUBJECT OBJECTIVES

  • Learning about multimedia processing methods
  • Acquiring knowledge of programming multimedia processing applications
  • Acquisition of knowledge in the use of multimedia containers
  • Acquisition of knowledge in the field of software testing
  • Acquiring the ability to analyze multimedia signals
  • Acquiring the ability to use tools that facilitate planning and running a programming project
  • Acquiring the skills to automate software tests

The project is carried out by specialists from Dolby Poland Sp. z o.o. from Wroclaw.

Project assumptions

The aim of this project is to create a web application enable of concerts streaming.

TODO Hosting Concert Live Streams

Host of the frontend application:

https://video-conferencing-app-pwr.herokuapp.com/

Preview Images:

Welcome

Preview Image

Prerequisites [for developers]

You’ll want to make sure that you have a decent understanding of the following:

  • JavaScript/ Node.js (v14.16.0 or above)
  • React
  • Redux/Redux Saga

You will also want to ensure that you have the following installed on your machine:

  • Homebrew (Latest)
  • Node.js (v14.16.0 or above)
  • Yarn (Latest)
  • Create React App (CRA)

Ensure that you have the following installed on your machine:

And, you’ll need to have created free accounts with the following services:

  • Heroku (for hosting the API)
  • Stream (for real-time chat functionality)
  • Dolby.io (for video conferencing)

Getting started [for developers]

This project only includes the Frontend UI!

Happy coding! ✌️

Step 1: Open Your terminal in the target directory and run:

# Node Package Execute
npx create-react-app your_application_name

Note: With create-react-app, you must prepend all environment variables with REACT_APP. You will need the following environment variables in your .env file:

  • REACT_APP_STREAM_KEY
  • REACT_APP_VOX_KEY
  • REACT_APP_VOX_SECRET

Step 2: Replace all files with those contained in this repository

Step 3: Setting up the Backend API & Authentication

TODO :)

Backend Project Structure

Backend API is not meant for production as there is no auth in place. Please use carefully in testing and development environments only!

Full Breakdown

.
├── LICENSE
├── Procfile
├── README.md
├── app.json
├── env.example
├── package.json
├── src
│   ├── controllers
│   │   └── v1
│   │       └── token
│   │           ├── index.js
│   │           └── token.action.js
│   ├── index.js
│   ├── routes
│   │   └── token.js
│   └── utils
│       └── controllers.js
└── yarn.lock

Controllers:

.
└── v1
    └── token
        ├── index.js
        └── token.action.js

Token:

.
└── token.js

Running the application [for developers]

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Final Thoughts

TODO