# flat

**Repository Path**: chenpan2111/flat

## Basic Information

- **Project Name**: flat
- **Description**: https://github.com/netless-io/flat.git
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2021-11-25
- **Last Updated**: 2023-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
    <img width="200" height="200" style="display: block;" src="./assets/flat-logo.svg">
</div>

<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.whiteboard.agora.io/en/">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>

## Try it now

- [Start using Flat Web][flat-web]
- [Download artifact][flat-homepage]
- [Flat Components Storybook][flat-storybook]

## Related Projects

- [Flat Android][flat-android]
- [Flat Server][flat-server]
- [Flat HomePage][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](#storybook).

### Installation

```shell
yarn run bootstrap
```

### Development Mode

#### web

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

#### electron

```shell
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][flat-storybook]).

- Run `yarn run storybook` at project root to run Storybook locally.

## Documents

- [Release Version Description](docs/releases)
- [Environment Variables Reference](docs/env/README.md)
- [Debugging Flat](docs/debugging/README.md)

## Contributing

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

* [Improve documentation](CONTRIBUTING.md#improve-documentation)
* [Improve issues](CONTRIBUTING.md#improve-issues)
* [Give feedback on issues](CONTRIBUTING.md#give-feedback-on-issues)

For more info about how to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md)

## Code Contributors

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

<a href="https://github.com/netless-io/flat/graphs/contributors"><img src="https://opencollective.com/agora-flat/contributors.svg?width=890&button=false"/></a>

## License

Copyright © Agora Corporation. All rights reserved.

Licensed under the [MIT license](LICENSE).

When using the Flat or other GitHub logos, be sure to follow the [GitHub logo guidelines][github-logo].

[flat-homepage]: https://flat.whiteboard.agora.io/en/#download

[flat-web]: https://flat-web.whiteboard.agora.io/

[flat-server]: https://github.com/netless-io/flat-server

[flat-android]: https://github.com/netless-io/flat-android

[flat-storybook]: https://netless-io.github.io/flat/

[github-logo]: https://github.com/logos