riadvice / bbbeasy

Easy Multi-purpose Rooms Manager for BigBlueButton, with fine-grained and fully customisable configuration

BBBEasy

BBBEasy is an open-source multipurpose meeting rooms manager for BigBlueButton.

Features

• Smooth installation experience.

• User friendly UI.

• Manage different configuration presets and assign them to rooms.

• Rooms management.

• Users management.

Components

The web-application is split in two parts:

• A server API.

• A modern front-end.

🪴 Project Activity

Development

• To launch the backend in the development mode, follow these steps :

         1- Start a Command Prompt as an Administrator.

         2- Run cd /path/to/cloned/project/.

         3- Run vagrant up && vagrant ssh and wait until the end of the process.

         4- Run cp /app/bbbeasy-backend/app/config/config-development.sample.ini /app/bbbeasy-backend/app/config/config-development.ini.

• To launch the frontend in the development mode, follow these steps :

         1- Run cd /app/bbbeasy-frontend.

         2- Run cp /app/tools/bbbeasy /app/bbbeasy-frontend/bbbeasy.

         3- Run sed -i -e 's/\r$//' bbbeasy.

         4- Run sed -i -e 's/"bbbeasy /".\/bbbeasy /g' package.json.

         5- Run yarn start-dev-installer to enable the installer app or yarn start-dev to enable the web app.

Contributing

Security

Testing

Backend test:

• From the browser: http://bbbeasy.test/api?statera or http://bbbeasy.test/api?statera=withCoverage

Frontend test:

• To start testing with Cypress, follow these steps :

         1- Enable the installer app as described in Development heading.

         2- Run yarn cypress.

         3- When the Command Prompt displays Wait 30 seconds until enabling web app (manually), terminate the running installer app.

         4- Run yarn start-dev within 30 seconds.

Technologies

Node.js

React JS

Redis

Percona Distribution for PostgreSQL

TypeSCript

Cypress

NGINX

Vagrant

bbbeasy's Issues

Edit room details

User authentication using "Google"

Preset copy

Update user details

A room can have a start and end date

List all labels

Add custom metadata to room creation

Create a default preset for every new user

Implement JWT

Start rooms in batch

Filter rooms by labels

Select , apply guidelines and put them in the contribution makrdown file

https://www.simform.com/blog/react-architecture-best-practices/

https://www.codeinwp.com/blog/react-best-practices/

https://reactresources.com/topics/best-practices

https://itnext.io/react-project-architecture-641da390ebe7?gi=7c1066b4df4d

https://buttercms.com/blog/best-practices-for-building-a-large-scale-react-application

https://github.com/markerikson/react-redux-links/blob/master/react-architecture.md

Branding configuration

User authentication using "OpenID"

Change default font color to grayish black

Default text color is #464a53

Send details in the invitation

• Calendar comaptible
• Phone number
• Access codes

User authentication using "LDAP"

Improve forms validation

From a user experience perspective the form validation should have direct effect on the user inputs. We have different ways to achieve that but we need to have a per-input error display. Global red box error summary display to avoid as much has possible.

We have multiple ways doing so:

1. Easiest: Validate in the client, then do validation in the server, global error box will display very rarely.
2. Longest: Validate data only in the server, but validated error must be returned into an array and each error displayed in its field.

So global error display might be removed.

Send invitation for room

Assign labels to a room

Nginx configuration for production

Account creation policy

Account creation policy is in the site settings.

Design the room box component

Create room

Implement public/restricted routes

Originally from @MohamedRWalha

We need a clear design for the roles/permissions.

• Add new metadata @acl in tghe class with params "VERB @alias" or just @alias
• List all classes loaded by SPL under Actions\ (filter)
• Model to be configurable to acl is Actions\${Model} and action is the class name.
• Load routes in session using @acl and saved data.

==> dynamic output

$role is the user role in the sessions
$f3->allow('@aclvalue', '$f3->session()->userRole()')

If I select a permission all underneath permissions must be pre-selected.

Agree about a convention naming routes

GET @user_view
POST @user_add
PATCH @user_update
DELETE @user_delete
POST @user_merge

Start looking here https://www.php.net/manual/fr/class.reflectionclass.php

Load data into redis cache after reading it the first time, othewise cached permissions list must be manually cleared.

Transfer room to user

Move from webpack to snowpack

It might be better to make the build faster especially for development.

https://blog.slashgear.dev/should-snowpack-replace-webpack/

https://rangle.io/blog/how-to-migrate-a-create-react-app-cra-from-webpack-to-snowpack/

Build an installable electron application for desktop

User authentication using "Office365"

Delete room

All API messages must be put in into locale (front & back)

Import users from CSV

Secure sending JS console logs to the server

The easiest is to accept the logs only for authenticed users.

Need to find a way to invert the rule !=visitor in ACL.

Delete rooms in batch

First room creation

Display user rooms list

Display a specific user rooms

Publish/Unpublish recording

Make file upload configuration work on the backend

Assign a preset to a room

Delete a label

Protocolise data transfer between frontend and backend

Edit a label

Create a label

Delete a recording

Import roles from CSV

List a room recordings

Create rooms in batch

Document upload for preset

Soft deletion configuration