Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getstream/stream-video-flutter

Flutter Video SDK - Build your own video app experience using Dart, Flutter and the Stream Video Messaging API.
https://github.com/getstream/stream-video-flutter

android flutter ios livestreaming video video-calling-sdk voip webrtc

Last synced: 2 days ago
JSON representation

Flutter Video SDK - Build your own video app experience using Dart, Flutter and the Stream Video Messaging API.

Host: GitHub
URL: https://github.com/getstream/stream-video-flutter
Owner: GetStream
License: other
Created: 2022-07-08T19:34:44.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-29T10:42:03.000Z (4 months ago)
Last Synced: 2024-10-29T11:44:41.761Z (4 months ago)
Topics: android, flutter, ios, livestreaming, video, video-calling-sdk, voip, webrtc
Language: Dart
Homepage: https://getstream.io/video/docs/flutter/
Size: 26.6 MB
Stars: 46
Watchers: 13
Forks: 21
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

# Official Flutter packages for the [Stream Video SDK](https://getstream.io/video/sdk/flutter/)

Stream Video for Flutter Header image

[![CI](https://github.com/GetStream/stream-video-flutter/actions/workflows/stream_video_flutter_workflow.yml/badge.svg?branch=main)](https://github.com/GetStream/stream-video-flutter/actions/workflows/stream_video_flutter_workflow.yml)
[![Melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos)

## Quick Links

- [Register](https://getstream.io/video/) to get an API key for Stream Video
- [Sample apps](https://github.com/GetStream/flutter-video-samples)

This repository contains code for our [Dart](https://dart.dev/) and [Flutter](https://flutter.dev/) video clients.

We use [Melos](https://melos.invertase.dev) to manage this repository.

## Understanding the structure of the repository

* The `packages` folder contains the packages and plugins that the SDK consists of.
* The `examples` folder holds the samples created using the Flutter Video SDK.
* The `docusaurus` folder contains the documentation and guides.
* The `dogfooding` folder contains a complete example app that implements all of the features of the SDK.

## Process to get started with this repository

1. Clone the base repository.
2. All API keys and users used in the sample apps are to be stored in a file named '.env' at the root of the project.
3. You will find a template for the env file entitled 'env.sample' at the root of the project. Fill out this template and store it as '.env'.
4. Run `melos postclean` to clean the project.
5. Run `melos bootstrap` to fetch dependencies for all projects.
6. Run `melos generate:all` to generate the required env files. If there are any changes in the '.env' file, regenerate this.
7. You can now run any app in the project or start making changes to the SDK.

If you see any unexpected behaviour in the repository, feel free to [file an issue](https://github.com/GetStream/stream-video-flutter/issues/new) in the repository.

## Roadmap

Video roadmap and changelog is available [here](https://github.com/GetStream/protocol/discussions/127)

The Flutter specific roadmap is available [here](development.md).