README.md

HybridPlanner makes planning meetings with external participants a breeze.

Table of Contents

• 🚀 Built with ReactJS
• 🔑 Prerequisites
• 🔧 Installation
  • 🐳 Using Docker
• 🔍 How to Use HybridPlanner
  • 📆 Create a New Meeting
  • 📝 Join a Meeting

🚀 Built with ReactJS

HybridPlanner's frontend is built using ReactJS, providing a modern and efficient user interface.

We also used Storybook to develop and test the components in isolation.

🔑 Prerequisites

• Node.js
• Docker (optional)

Note: Ensure you start the backend server before using the application. Find the backend repository here.

🔧 Installation

1. Clone the repository.
2. Install dependencies

   npm install

3. Start the application

   npm run start

4. Open the application in your browser: http://localhost:5173

🐳 Using Docker

1. Clone the repository.
2. Use the docker-compose file to start the application

   docker-compose up

3. Open the application in your browser.

🔍 How to Use HybridPlanner

⚠️ Ensure the backend server is running before following the steps below.

📆 Create a New Meeting

1. Go to the dashboard and fill out the form with the meeting details and the participants you want to invite.
2. Click on "Plan meeting" to create the meeting.
3. The meeting is now created, and you can view the meeting details and the participants you invited.

💡 Participants will receive an email with a link to the meeting details.

📝 Join a Meeting

1. Go to the dashboard and click on the meeting you want to join.
2. Click on the 🔗 link of the meeting you created, and you will be redirected to a waiting page with a countdown. You will be automatically redirected to the meeting page when the countdown is over.

💡 You can also join the meeting by clicking on the link in the email you received.