Search packages, repositories and app categories

GitHub repositoryflappwrite/auth_kit

appwrite_auth_kit

Making Appwrite Authentication Easy

appwrite_auth_kit project cover
Stars
34
Forks
14
Last push (UTC)
Aug 2, 2024
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

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

  1. Add dependency
dependencies:
    appwrite_auth_kit: <version>
  1. 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(),
      ),
    );
  }
}
  1. 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.
  2. 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;
  }
}
  1. 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.
flappwrite GitHub avatar
GitHub author

flappwrite ↗

LanguagesDartCMakeC++RubySwiftHTMLCKotlinObjective-C

Categories

Dependencies used

Dependency list 4 items

  • appwrite^12.0.0
  • flutter{"sdk":"flutter"}
  • flutter_lintsDevelopment^4.0.0
  • flutter_testDevelopment{"sdk":"flutter"}

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗