fballan93 / appwrite_auth_kit Goto Github PK

View Code? Open in Web Editor NEW

Making Appwrite Authentication Easy

License: MIT License

Ruby 7.50% C++ 12.02% C 1.93% Objective-C 0.11% Kotlin 0.41% Dart 48.18% Swift 4.95% HTML 4.32% CMake 20.58%

appwrite_auth_kit's Introduction

Appwrite Auth Kit

A Flutter wrapper for Appwrite's Accounts service, makes it easy to use manage authentication and account features.

Getting Started

This is really very easy to use

Add dependency

dependencies:
    appwrite_auth_kit: <version>

Wrap your MaterialApp AppwriteAuthKit passing a properly initialized Appwrite Client. Example below:

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late Client client;
  @override
  void initState() {
    super.initState();
    //initialize your client
    client = Client();
    client
        .setEndpoint('https://localhost/v1')
        .setProject('60793ca4ce59e')
        .setSelfSigned();
  }

  @override
  Widget build(BuildContext context) {
    return AppwriteAuthKit(
      client: client,
      child: MaterialApp(
        title: 'Flutter Demo',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: MainScreen(),
      ),
    );
  }
}

Access authNotifier from context. authNotifier is an instance of AuthNotifier that provides all the functions of Appwrite's Account service and some easy way to handle authentication.
Get context.authNotifier.status gets the authentication status which can be one of the AuthStatus.uninitialized, AuthStatus.unauthenticated, AuthStatus.authenticating and AuthStatus.authenticated. You can check the status and display the appropriate UI, for example

class MainScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final authNotifier = context.authNotifier;

    Widget widget;
    switch (authNotifier.status) {
      case AuthStatus.authenticated:
        widget = AdminPage();
        break;
      case AuthStatus.unauthenticated:
      case AuthStatus.authenticating:
        widget = LoginPage();
        break;
      case AuthStatus.uninitialized:
      default:
        widget = LoadingPage();
        break;
    }
    return widget;
  }
}

You must use the functions from the context.authNotifier instead default Account service from Appwrite SDK to create user, create session (login), delete session (logout), so that the context.authNotifier?.status is properly updated and your UI updates accordingly.

Recommend Projects