Codebase Overview

Codebase Overview

Overview

1. A bridge has been created to connect the firebase auth & StreamChat SDK

2. There are three important things to notice that are common to all Flutter application using StreamChat:

• The Dart API client is initialized with your API Key
• The current user is set by calling connectUser on the client
• The client is then passed to the top-level StreamChat widget

3. The top level StreamChatClient is returned in home_page.dart, StreamChat is an inherited widget and must be the parent of all Chat related widgets, we will cover later how you can leverage the inherited widget APIs to build more advanced customizations to your application.

4. A channel contains messages and a list of members who are permanently associated with the channel and a list of watchers currently watching the channel.

5. The ChannelListPage widget retrieves the list of channels based on a custom query and ordering using the ChannelsBloc inherited widget

6. To add data persistence ChatPersistenceClient is extended and passed as an instance to the StreamChatClient.

7. To read more, Please refer to the tutorial for steps.

Directory Structure of /lib

1. A good, structured catalogue of projects and relevant resources proofs design-processes and teamwork, speed-ups designer’s work. It helps new employees to natively understand the catalogue. It also allows separate accesses for security issues.
2. In order to develop a scalable application that can be extended to ios, web, and desktop using flutter cross-platform, I have maintained a clean directory structure in line with Agile methodologies as follows:

(Self-explanatory / Internal files are not mentioned.)

• config/ - constants used in the application
  • constants.dart
  • custom_colors.dart
• pages/ - The Widgets of all the pages / screens in the application
  • chats/ - All Pages related to the chat functionality
    • group_chat/ - All Pages related to group chats or channels
      • channel_file_page.dart
      • channel_info_page.dart
      • channel_media_page.dart
      • channel_name_page.dart
      • channel_page.dart
    • new_chat/ - All Pages related to Create a new group / Chat Functionality
      • add_channel_members_page.dart
      • chips_input_text_field.dart
      • new_chat_page.dart
    • widgets/ - Modular Widgets used commonly in this chat sub directory
      • files_option_tile.dart
      • media_option_tile.dart
      • mute_option_tile.dart
      • pin_option_tile.dart
    • chat_info_page.dart
    • chats_home_page.dart - The home page of all the chats
    • pinned_messages_page.dart
    • thread_page.dart
  • login/ - All Pages related to Login
    • google_sign_in_button.dart
    • sign_in_page.dart
    • user_info_page.dart
  • meetings/ - All Pages related to Create & Join Meeting Functionality
    • create_meetings_page.dart
    • join_meetings_page.dart
    • meetings_page.dart
  • mentions/ - The mentions page to list user mentions
    • user_mentions_page.dart
  • onboarding/ - All Pages related to the onboarding screen
    • share_screen.dart
    • splash_screen.dart
    • video_screen.dart
    • welcome_screen.dart
• routes/ - Contains all the routes used and generated in the application
  • app_routes.dart
  • routes.dart
• services/ - Contains The service initialisation logic for StreamChat & Authentication using Firebase in the application
  • authentication/
    • authentication.dart
  • notifications/ - Work in progress Notification implementation for android
    • notifications_service.dart
  • stream_chat/
    • chat_list.dart
    • stream_api.dart
• widgets/
  • drawer.dart - The Drawer Widget of the Application
  • rounded_button.dart
  • search_text_field.dart
• home_page.dart - Contains the top level Stream Chat widget
• main.dart - The entry point for execution

Coding Style & Conventions

• This application follows the Effective Dart: Style & the repository is maintained following Agile Methodologies and Gitflow Workflow