Skip to content
/ flat Public
forked from netless-io/flat

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

License

Notifications You must be signed in to change notification settings

firesiva/flat

 
 

Repository files navigation

Agora Flat

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

中文

Try it now

Features

  • Open sourced front-end and back-end
  • 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

Code Contributors

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

About

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

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 87.9%
  • Less 7.4%
  • JavaScript 4.3%
  • HTML 0.2%
  • Smarty 0.1%
  • AppleScript 0.1%