github_signin_aksoyhlc

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The github_signin_aksoyhlc package simplifies adding GitHub login and registration to Flutter apps using the official GitHub OAuth API. It provides a streamlined, secure way to authenticate users via GitHub across multiple platforms, including Android, iOS, Web, macOS, and Windows. Designed for developers seeking a straightforward integration without managing OAuth flows manually, it handles token management and user data retrieval efficiently. The package is lightweight and compatible with modern Flutter projects.

Use cases

Integrating GitHub login in mobile apps
Enabling GitHub sign-up for web applications
Adding social authentication to cross-platform apps
Simplifying OAuth flow for developer onboarding
Securing user access with GitHub identity

Key features

Official GitHub OAuth API integration
Cross-platform support (Android, iOS, Web, macOS, Windows)
Secure token handling
Minimal setup required
User profile data retrieval

Suitable for

Flutter developers building apps with GitHub auth
Projects requiring social login options
Apps targeting multiple platforms
Developers wanting quick OAuth implementation
Startups prioritizing fast user onboarding

Considerations

Requires GitHub App registration with redirect URI
Needs proper configuration of OAuth client ID and secret
Dependent on internet connection during login
May require additional privacy policy disclosure
Limited to GitHub as the sole authentication provider

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Getting Started

Add package dependency

github_signin_aksoyhlc: any

Example 1

	var params = GithubParamsModel(  
		clientId: 'xxxxxx',  
		clientSecret: 'yyyyyy',  
		callbackUrl: 'http://example.com',  
		scopes: 'read:user,user:email',  
	);  
	  
	GithubSignInResponse result = await GithubSignIn.signIn(context, params: params);

    	if (result.status != ResultStatus.success) {  
		// handle error
		print(result.message);
	} else {
		///TODO: use result  
	}

Example 2

	var params = GithubParamsModel(  
		clientId: 'xxxxxx',  
		clientSecret: 'yyyyyy',  
		callbackUrl: 'http://example.com',  
		scopes: 'read:user,user:email',  
	);  
	  
	dynamic result = Navigator.push(context, MaterialPageRoute(builder: (context) => GithubSignIn(params: params)));  
	  
	if (result == null) {  
		// user cancelled the sign in or error occurred
	}  
	  
	var data = result as GithubSignInResponse;  
	  
	if (data.status != ResultStatus.success) {  
		print(result.message);
	}  
	  
	///TODO: use response data

Custom AppBar

	GithubSignIn(
		params: params,
		appBar: PreferredSize(
			child: AppBar(
  				title: Text("Github Sign In"),
			),
			preferredSize: const Size.fromHeight(56),
		)
	)

Search packages, repositories and app categories

Install package