README.md

Agora Flat

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

中文

Try it now

• Start using Flat Web
• Download artifact
• Flat Components Storybook

Features

• Open sourced front-end and back-end
  • Flat Web
  • Flat Desktop (Windows and macOS)
  • Flat Android
  • Flat Server
• Optimized teaching experience
  • Big class
  • Small class
  • One on one
• Real-time interaction
  • Multifunctional interactive whiteboard
  • Real-time video/audio chat(RTC)
  • Real-time messaging(RTM)
  • Participant hand raising
• Login via
  • Wechat
  • GitHub
  • Google
• Classroom management
  • Join, create and schedule classrooms
  • Support periodic rooms
  • View room history
• Classroom recording and replaying
  • Whiteboard replaying
  • Cloud recording for video and audio
  • Messaging replaying
• Cloud Storage for multi-media courseware
• Device self-check
• 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 run storybook at project root to run Storybook locally.

Documents

• Environment Variables Reference

Code Contributors

Thank you to all the people who already contributed to Flat!