netless-io/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

Related Projects

• Flat Android
• Flat Server
• Flat HomePage

Features

• 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

Development

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

Installation

yarn run bootstrap

Development Mode

web

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

electron

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

• Release Version Description
• Environment Variables Reference
• Debugging Flat

Contributing

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

• Improve documentation
• Improve issues
• Give feedback on issues

For more info about how to contribute, see CONTRIBUTING.md

Code Contributors

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

License

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.