netless-io/flat — Gitpedia

<p align="center"> <img width="92" height="92" style="display: block;" src="./assets/flat-logo.svg"> </p> <div align="center"> <img alt="GitHub" src="https://img.shields.io/github/license/netless-io/flat?color=9cf&style=flat-square"> <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/netless-io/flat?color=9cf&style=flat-square"> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/netless-io/flat?color=9cf&style=flat-square"> <a target="_blank" href="https://github.com/netless-io/flat/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22"> <img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/netless-io/flat/good%20first%20issue?color=9cf&label=good%20first%20issue&style=flat-square"> </a> <br> <a target="_blank" href="https://twitter.com/AgoraFlat"> <img alt="Twitter URL" src="https://img.shields.io/badge/Twitter-AgoraFlat-9cf.svg?logo=twitter&style=flat-square"> </a> <a target="_blank" href="https://github.com/netless-io/flat/issues/926"> <img alt="Slack URL" src="https://img.shields.io/badge/Slack-AgoraFlat-9cf.svg?logo=slack&style=flat-square"> </a> </div> <div align="center"> <h1>Agora Flat</h1> <p>Project flat is the Web, Windows and macOS client of <a href="https://flat.agora.io/">Agora Flat</a> open source classroom.</p> <p><a href="./docs/readme/README-zh.md">中文</a></p> <img src="./assets/flat-showcase-en.png"> </div>

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:

Flat Electron client is an Electron implementation of Flat client.
Flat Web client is a web implementation of Flat client.

Installation

If you don't have pnpm installed:
bash
npm i -g pnpm

Clone or fork this project, at project root run:

bash
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.

shell
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.

shell
pnpm start:web

Alternatively, run the following command:

shell
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

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.