tellam 0.1.1

  • Readme
  • Changelog
  • Example
  • Installing
  • new52

tellam #

Tellam flutter package to integrate FAQ and live support chat using firebase.

Getting Started #

For help getting started with Flutter, view our online documentation.

For help on editing plugin code, view the documentation.

Important #

Tellam depends on firebase database. Firebase database must be configured before you can use tellam.

For help on adding firebase database, view the documentation

Usage #

To use this package :

dependencies:
    flutter:
      sdk: flutter
    tellam:

Then initialize the package whenever you need it:


//setup tellam
  Tellam.initialize(    
    //secretKey: "YOUR-SECRET-KEY",
    databaseUrl: "YOUR-FIREBASE-DATABASE-URL",
    uiconfiguration: UIConfiguration(
      accentColor: Colors.red[300],
      primaryColor: Colors.red[600],
      primaryDarkColor: Colors.red[900],
      buttonColor: Colors.red[400],
    ),
  );

To enable live chat you need to register a user


//register tellam user
TellamUser tellamUser = TellamUser(
    //required
    id: userAccount.id,
    firstName: userAccount.firstName,
    //the rest are optional
    lastName: userAccount.lastName,
    emailAddress: userAccount.emailAddress,
    phoneNumber: userAccount.phoneNumber,
    photo: userAccount.photo,
);

Tellam.client().register(tellamUser);

To show tellam FAQ and live support page/view


    //show tellam page/view
    Tellam.show(
        context,
        //true if you want your user to be able to contact support team via the live chat section
        //note you must have register a user to use this feature
        enableChat: true,
    );

▶️ Running Example project #

For help getting started with Flutter, view the online documentation.

An example project has been provided in this plugin. Clone this repo and navigate to the example folder. Open it with a supported IDE or execute flutter run from that folder in terminal.

:pencil: Contributing, 😞 Issues and 🐛 Bug Reports #

The project is open to public contribution. Please feel very free to contribute. Experienced an issue or want to report a bug? Please, report it here. Remember to be as descriptive as possible.

🏆 Credits #

None yet

[0.0.1] - 2020-06-29 #

  • Tellam flutter package to integrate FAQ and live support chat using firebase.

[0.1.1] - 2020-06-30 #

  • Updated dependencies

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:tellam/tellam.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  //initialize tellam with firebase database url
  await Tellam.initialize(
    databaseUrl: "https://tellam-6ee8e.firebaseio.com/",
  );

  //setting the user data
  TellamUser tellamUser = TellamUser(
    id: 6,
    firstName: "Ambrose",
    lastName: "Bako",
  );

  //register user data
  Tellam.client().register(tellamUser);

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Tellam Demo',
      theme: ThemeData(
        primarySwatch: Colors.teal,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: MyHomePage(title: 'Tellam Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Text("Tellam Inc."),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          //display tellam faq and live chat if needed
          Tellam.show(
            context,
            enableChat: true,
          );
        },
        tooltip: 'Help',
        child: Icon(Icons.chat),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  tellam: ^0.1.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:tellam/tellam.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
9
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
52
Learn more about scoring.

We analyzed this package on Jul 9, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.14
  • Flutter: 1.17.5

Analysis suggestions

Package does not support Flutter platform android

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package does not support Flutter platform ios

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package does not support Flutter platform linux

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package does not support Flutter platform macos

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package does not support Flutter platform web

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package does not support Flutter platform windows

Because:

  • package:tellam/tellam.dart that imports:
  • package:tellam/src/views/help_page.dart that imports:
  • package:tellam/src/widgets/header_title_tile.dart that imports:
  • package:tellam/src/database/models/faq_topic.dart that imports:
  • package:floor/floor.dart that imports:
  • package:floor/src/sqflite_database_factory.dart that imports:
  • package:sqflite_common_ffi/sqflite_ffi.dart that imports:
  • package:sqflite_common_ffi/src/windows/setup.dart that imports:
  • package:moor_ffi/open_helper.dart that declares support for platforms:

Package not compatible with SDK dart

Because:

  • tellam that is a package requiring null.

Health issues and suggestions

Document public APIs. (-1 points)

45 out of 45 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/src/database/AppDatabase.g.dart. (-0.50 points)

Analysis of lib/src/database/AppDatabase.g.dart reported 1 hint:

line 424 col 16: Name non-constant identifiers using lowerCamelCase.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (flutter_svg).

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
bubble ^1.1.9+1 1.1.9+1
cached_network_image ^2.2.0+1 2.2.0+1 2.3.0-rc
firebase_database ^3.1.6 3.1.6
floor ^0.13.0 0.13.0
flutter 0.0.0
flutter_gradient_colors ^1.0.0 1.0.0
flutter_html ^1.0.0 1.0.0
flutter_icons ^1.0.0+1 1.1.0
flutter_svg ^0.17.4 0.17.4 0.18.0
intl ^0.16.0 0.16.1
rxdart ^0.24.1 0.24.1
sqflite ^1.3.0 1.3.1
timeago ^2.0.26 2.0.26
url_launcher ^5.4.11 5.5.0
Transitive dependencies
charcode 1.1.3
chewie 0.9.10
chewie_audio 1.0.0+1
clock 1.0.1
collection 1.14.12 1.14.13
convert 2.1.1
crypto 2.1.5
css_colors 1.0.2
csslib 0.16.1
ffi 0.1.3
file 5.2.1
firebase 7.3.0
firebase_core 0.4.5
firebase_core_platform_interface 1.0.4
firebase_core_web 0.1.1+2
floor_annotation 0.8.0
flutter_cache_manager 1.4.1
flutter_web_plugins 0.0.0
html 0.14.0+3
http 0.12.1
http_parser 3.1.4
js 0.6.2
matcher 0.12.8
meta 1.1.8 1.2.2
moor 3.2.0
moor_ffi 0.7.0
open_iconic_flutter 0.3.0
path 1.7.0
path_drawing 0.4.1
path_parsing 0.1.4
path_provider 1.6.11
path_provider_linux 0.0.1+2
path_provider_macos 0.0.4+3
path_provider_platform_interface 1.0.2
pedantic 1.9.0 1.9.2
petitparser 3.0.4
platform 2.2.1
platform_detect 1.4.0
plugin_platform_interface 1.0.2
process 3.0.13
pub_semver 1.4.4
quiver 2.1.3
screen 0.0.5
sky_engine 0.0.99
source_span 1.7.0
sqflite_common 1.0.2+1
sqflite_common_ffi 1.0.0+4
stack_trace 1.9.5
string_scanner 1.0.5
synchronized 2.2.0+1
term_glyph 1.1.0
typed_data 1.1.6 1.2.0
url_launcher_linux 0.0.1+1
url_launcher_macos 0.0.1+7
url_launcher_platform_interface 1.0.7
url_launcher_web 0.1.2
uuid 2.2.0
vector_math 2.0.8 2.1.0-nullsafety
video_player 0.10.11+2
video_player_platform_interface 2.0.2
video_player_web 0.1.3+2
wakelock 0.1.4+2
webview_flutter 0.3.22+1
xdg_directories 0.1.0
xml 3.7.0 4.2.0
Dev dependencies
build_runner ^1.7.3
floor_generator ^0.13.0
flutter_test