• Stars
    star
    5,700
  • Rank 7,159 (Top 0.2 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 4 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

Agora Flat

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

ไธญๆ–‡

Features

  • Real-time interaction
    • Multifunctional interactive whiteboard
    • Real-time video/audio chat (RTC)
    • Real-time messaging (RTM)
  • Login via
    • GitHub
    • WeChat
  • 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

Quickstart

You can build and run the Flat client without a server. This repository includes the following projects:

Installation

If you don't have pnpm installed:

npm i -g pnpm

Clone or fork this project, at project root run:

pnpm i

Build and run Flat Electron client

Run the following commands at the root of the repository to build and run Flat Electron client.

pnpm start

You can use one of the following methods to package your executable:

  • Run pnpm ship at project root to package based on current system.
  • Alternatively, run pnpm ship:mac or pnpm ship:win at project root to package for a specified system.

Build and run Flat Web client

Run the following command at the root of the repository to build and run Flat web client.

pnpm start:web

Alternatively, run the following command:

cd ./web/flat-web/ && pnpm start

UI and business logic are separated in Flat. You can view and develop Flat components UI via Storybook. You can either visit the (Online address) or run pnpm storybook at the root of the repository to run Storybook locally.

References

Related Projects

Contributing

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 CONTRIBUTING.md

Code Contributors

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

Disclaimer

You may use Flat for commercial purposes but please note that we do not accept customizational commercial requirements and deployment supports. Nor do we offer customer supports for commercial usage. Please head to Flexible Classroom for such requirements.

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.

More Repositories

1

flat-server

A Node.js server for the Agora Flat open source classroom.
TypeScript
643
star
2

flat-android

Project Flat Android is the Android client of Agora Flat open source classroom.
Kotlin
108
star
3

netless-rtc-react-whiteboard

Demo https://demo-rtc.herewhite.com/#/zh-CN/
TypeScript
71
star
4

whiteboard-demo

TypeScript
66
star
5

netless-app

Official Apps for the Agora Interactive Whiteboard.
TypeScript
58
star
6

fastboard

An open sourced whiteboard starter based on white-web-sdk.
TypeScript
53
star
7

flat-iOS

Project Flat iOS is the iOS client of Agora Flat open source classroom.
Swift
50
star
8

Whiteboard-iOS

Whiteboard
Objective-C
30
star
9

netless-react-whiteboard

netless whiteboard demo https://demo.herewhite.com/#/zh-CN/
TypeScript
24
star
10

whiteboard-android

Java
22
star
11

white-fast-web-sdk

TypeScript
14
star
12

netless-token

sample codes to generate token for Netless services
JavaScript
14
star
13

window-manager

a window management system based on white-web-sdk
TypeScript
13
star
14

vue-whiteboard

Vue
11
star
15

Whiteboard-bridge

white-web-sdk, white-sdk-ios, white-sdk-android
TypeScript
10
star
16

netless-slide-demo

ๅŸบไบŽ canvas ็š„ pptx to html
JavaScript
9
star
17

flat-landing-page

https://github.com/netless-io/flat
HTML
7
star
18

whiteboard_flutter

A flutter library for Agora Whiteboard
Dart
6
star
19

fastboard_flutter

A flutter library for Agora Fastboard
Dart
6
star
20

community-apps

Community Netless Apps for Whiteboard Window Manager.
4
star
21

community-app-template

Community Netless Apps for Whiteboard Window Manager.
JavaScript
4
star
22

sync-player

TypeScript
4
star
23

legacy-netless-swift-whiteboard

Netless build iOS whiteboard demo with โค๏ธ
Swift
4
star
24

netless-combine-player

TypeScript
4
star
25

fastboard-iOS

Quickly create a whiteboard interface for iOS
Swift
4
star
26

docs

netless sdk documents
JavaScript
4
star
27

netless-iframe-bridge

TypeScript
3
star
28

synced-store

TypeScript
3
star
29

legacy-netless-android-whiteboard

Netless build Android whiteboard demo with โค๏ธ
Java
3
star
30

white-android-demo

3
star
31

canvas-polyfill

a polyfill for canvas getTransform, ellipse, resetTransform API
TypeScript
3
star
32

sync-player-iOS

Swift
2
star
33

fastboard-android

Java
2
star
34

react-native-fastboard

interactive whiteboard with user interface for react-native
TypeScript
2
star
35

telebox-insider

Experimental Whiteboard Windows UI.
TypeScript
1
star
36

vuplex-bridge

https://developer.vuplex.com/webview/overview
C#
1
star
37

watermark-pptx

automatically add watermark to all images in pptx
JavaScript
1
star
38

slide-prefetch

Simple script to prefetch packed slide data on navigation.
TypeScript
1
star
39

white-snapshot

TypeScript
1
star
40

whiteboard-flutter-bridge

Whiteboard-Flutter-bridge
TypeScript
1
star
41

y-app-attributes

Netless App Attributes adapter for Yjs
1
star
42

netless-ppt-plugin

1
star
43

rebirth

1
star
44

y

Shared utils for using CRDT in Netless Apps
TypeScript
1
star
45

electron-whiteboard-preload-demo

whiteboard preload demo in electron
TypeScript
1
star
46

SLSWeb

TypeScript
1
star
47

flat-server-docs

flat server docs (api / config / types)
1
star
48

netless-i18n-react-router

TypeScript
1
star
49

react-native-whiteboard

Whiteboard implements for react-native
TypeScript
1
star
50

pre-convert-demo

pre convert your ppt to whiteboard resources
JavaScript
1
star
51

sign-server

SignTool.exe as a server.
JavaScript
1
star