Agora Flat Open Source Classroom Client Build With React

Agora Flat

Project flat is the Web, Windows and macOS client of Agora Flat open source classroom.

Features

• Open sourced front-end and back-end
  • [x] Flat Web
  • [x] Flat Desktop (Windows and macOS)
  • [x] Flat Android
  • [x] Flat Server
• Optimized teaching experience
  • [x] Big class
  • [x] Small class
  • [x] One on one
• Real-time interaction
  • [x] Multifunctional interactive whiteboard
  • [x] Real-time video/audio chat(RTC)
  • [x] Real-time messaging(RTM)
  • [x] Participant hand raising
• Login via
  • [x] Wechat
  • [x] GitHub
  • [ ] Google
• Classroom management
  • [x] Join, create and schedule classrooms
  • [x] Support periodic rooms
  • [x] View room history
• Classroom recording and replaying
  • [x] Whiteboard replaying
  • [x] Cloud recording for video and audio
  • [x] Messaging replaying
• [x] Cloud Storage for multi-media courseware
• [x] Device self-check
• [x] Auto Updater

Development

UI and business logic are separated in Flat. You can run flat with development mode or quickly develop UI via Storybook.

Installation

At project root:

yarn run bootstrap

Development Mode

At project root:

yarn run start

Package Executable

• Run yarn ship at project root to package base on current system type.
• Or run yarn ship:mac or yarn ship:win at project root to package for the specified system.

Storybook

Many Flat components UI can be quickly viewed and developed via Storybook (Online address).

• Run yarn --cwd packages/flat-components storybook at project root to run Storybook locally.

Environment Variables Reference