UserOrient.com

Feature Voting Board for Flutter

UserOrient is a feature voting board that helps you collect feedback from your users and prioritize your development roadmap in your Flutter projects.

Getting Started

Considering that you have already created a project on UserOrient.com and received an API key, follow these steps to integrate the SDK into your Flutter app.

Add the dependency

Add the following to your pubspec.yaml file:

dependencies:
  userorient_flutter: <latest-version>

Initialize the SDK

Initialize the SDK with your project's API key and preferred language:

import 'package:userorient_flutter/userorient_flutter.dart';

void main() {
  UserOrient.configure(
    apiKey: 'YOUR_API_KEY',
    languageCode: 'en',
  );

Display the board

To show the UserOrient board, call UserOrient.openBoard(context):

import 'package:userorient_flutter/userorient_flutter.dart';

void openBoard() {
  // Set user information
  UserOrient.setUser(
    uniqueIdentifier: '123456',
    fullName: 'Kamran Bekirov',
    email: 'kamran@userorient.com',
    phoneNumber: '+1234567890',
    language: 'en',
    extra: {
      'age': 27,
      'is_premium': true,
    }
  );

  // Display the board
  UserOrient.openBoard(context);
}

Note: It's recommended to call UserOrient.setUser before each board launch to ensure up-to-date user information.

User Identification

UserOrient requires a unique identifier (uniqueIdentifier) for each user. This can be an email address, phone number, or custom ID. If not provided, UserOrient will generate a random identifier.

Logging Out

When a user logs out of your app, call UserOrient.clearCache() to prevent potential issues:

await UserOrient.clearCache();

Contact

For any questions or support, please reach out to us:

Made with 💙 by the UserOrient team

UserOrient/userorient-flutter