Agora Flat

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

中文

• Download artifact
• Flat Components Storybook

• 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

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

Note that full-built Flat requires Agora Flat Server backend.

1. Create two files config/.env.development.local and config/.env.production.local.
2. Add environment variables following the config/.env format.

• See Environment Variables Reference bellow.
• See Files under version control for more about .env.* naming.

1. Fork this repo so that Github Actions can work properly.
2. Then git clone the forked repo to local.
3. At project root：

   yarn run bootstrap

Run yarn start at project root.

• 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 --cwd packages/flat-components storybook at project root to run Storybook locally.