Agora Flat

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

中文

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

• Flat Android
• Flat Server
• Flat HomePage

• Real-time interaction
  • Multifunctional interactive whiteboard
  • Real-time video/audio chat(RTC)
  • Real-time messaging(RTM)
• Login via
  • Wechat
  • GitHub
• Classroom management
  • Join, create and schedule classrooms
  • Support periodic rooms
• Classroom recording and replaying
  • Whiteboard replaying
  • Cloud recording for video and audio
  • Messaging replaying
• Cloud Storage for multi-media courseware
• Screen sharing

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

yarn run bootstrap

yarn run start

• 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.

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.

• Release Version Description
• Environment Variables Reference
• Debugging Flat

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

Copyright © Agora Corporation. All rights reserved.

Licensed under the MIT license.

When using the Flat or other GitHub logos, be sure to follow the GitHub logo guidelines.