Schoolar Auth

Schoolar Auth is a Dart package that provides authentication functionalities for the Schoolar.io platform. This package simplifies the process of integrating authentication features into your Dart applications.

Features

  • User registration
  • User login
  • Password reset
  • Token-based authentication
  • User profile management

Installation

Add the following dependency to your pubspec.yaml file:

dependencies:
    schoolar_auth: ^1.0.0

Then, run flutter pub get to install the package.

Usage

Import the package

import 'package:schoolar_auth/schoolar_auth.dart';

Initialize the AuthService

final authService = AuthService(apiKey: 'YOUR_API_KEY');

User Registration

final user = await authService.register(
    email: 'user@example.com',
    password: 'securePassword',
);

User Login

final user = await authService.login(
    email: 'user@example.com',
    password: 'securePassword',
);

Password Reset

await authService.resetPassword(email: 'user@example.com');

Token-based Authentication

final token = await authService.getToken();

User Profile Management

final profile = await authService.getProfile();
await authService.updateProfile(profile);

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Additional Information

For more details, visit the official documentation.