Skip to content
Rahul Mangla edited this page Oct 20, 2023 · 5 revisions

Welcome to the Alfaaz wiki!

Alfaaz is a video conferencing application with rich integrated chat feature where teams can discuss on topics and connect with other members.

Coding Style & Conventions

This application follows the Effective Dart: Style & the repository is maintained using Gitflow Workflow.

A line limit of 80 characters is followed for comments and dart code

Project Setup

Before running this project please ensure Flutter is installed and configured on your machine. If you're new to Flutter, please checkout the official guide with installation instructions for your OS.

This project is only configured to support the following platforms:

  • Android
  • iOS

Web and Desktop are not supported at this time.

After installing Flutter and the necessary toolchain for your device (Android or iOS), connect your device or open your emulator before running the following:

Clone the repo

https://github.com/rahulmangla28/Alfaaz

Open the app folder

cd alfaaz

Install package dependencies

flutter packages get

Either connect to your physical device or create an emulator

# To create a new emulator, run 'flutter emulators --create [--name xyz]'.
# You can find more information on managing emulators at the links below:
# [https://developer.android.com/studio/run/managing-avds](https://developer.android.com/studio/run/managing-avds)[https://developer.android.com/studio/command-line/avdmanager](https://developer.android.com/studio/command-line/avdmanager)

Run the project on your device or emulator

flutter run.

Setup Stream Chat SDK

  • Sign up your account here.
  • Follow the Guide to setup.
  • Login to your dashboard and configure your project.

Setup Google Firebase

Refer to the official guide here.