Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.99 KB

readme.md

File metadata and controls

75 lines (50 loc) · 2.99 KB
Raw

Logo

LearnEase - Frontend

🚀 About LearnEase

LearnEase is an innovative virtual classroom application that takes video conferencing to the next level! With a focus on creating an engaging and interactive learning environment, LearnEase offers a plethora of exciting features designed to enrich the teaching and learning experience.

Features

  • Group Video: Engage in real-time video chats.
  • Live Whiteboard: Foster creativity and dynamic lessons.
  • Screenshare: Seamless sharing of multimedia content.
  • Live Chat: Encourage interactive discussions.
  • Document Sharing: Access study materials effortlessly.
  • Teaching Activities: Make learning enjoyable and impactful.
  • Grades: Track student progress efficiently.
  • JWT Auth: Secure and protected virtual environment.
  • Light/Dark Mode: Personalize your learning experience. 🚀📚

Installation and Setup

1 Prerequisites:

  • Make sure you have Node.js and npm (Node Package Manager) installed on your system. You can download and install them from the official Node.js website: https://nodejs.org/

2 Clone the Repository:

  • Open your terminal or command prompt.
  • Change the current working directory to where you want to store the LearnEase project.
  • Run the following command to clone the frontend repository:
git clone https://github.com/shahsad-kp/LearnEase-Client.git

3 Install Frontend Dependencies:

  • Change the current working directory to the project's frontend folder (e.g., LearnEase-Client).
  • Run the following command to install the frontend dependencies:
npm install

4 Environment Variables:

  • Refer environment variables for setting up the required environment variables for the LearnEase frontend.

5 Start the Development Server (Frontend):

  • After the dependencies are installed, start the frontend development server by running the following command:
npm run dev
  • This will build the frontend and open the development server at http://localhost:5173 (or another available port if 3000 is already in use).

Deploying the Backend

Before deploying your application, make sure to set up the backend server on your hosting platform. Ensure that you have all the necessary configurations, such as database connection settings, environment variables, and security measures in place.

For backend deployment, please refer to the backend repository for instructions and deployment guides:

LearnEase Backend Repository

Environment Variables

To run this project, you will need to add the following environment variables to your .env file and store it in the root directory of the project:

VITE_BACKEND_URL

VITE_WEBSOCKET_URL

Feedback

If you have any feedback, please reach me at [email protected] or connect me at LinkedIn

Support

Show your support by 🌟 the project!!