November 4, 2021

288 words 2 mins read



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

repo name netless-io/flat
repo link
language TypeScript
size (curr.) 46548 kB
stars (curr.) 2813
created 2020-08-26
license MIT License

Try it now


  • 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

Development Mode


yarn workspace flat-web start
# or
cd ./web/flat-web/ && yarn run start


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.


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.



Writing code is great, but there are many other ways to make meaningful contributions to the project:

For more info about how to contribute, see

Code Contributors

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.

comments powered by Disqus