@alore/auth-react-native-ui

Alore Native Auth - UI

This is a bare React Native library that provides authentication features. It simplifies the integration of authentication methods in your React Native applications. Additionally, it offers a pre-built UI component that leverages the @alore/auth-react-native-sdk to provide Alore authentication and wallet features.

Table of Contents

• Installation
• Usage
• Contributing
• License
• Contact

Installation

To install the required libraries, run the following command:

yarn add react-native-gesture-handler react-native-ui-lib react-native-svg crypto-browserify react-native-get-random-values

Then, install this library:

yarn add @alore/auth-react-native-ui

Usage

To use the Alore Native Auth UI in your project, follow these steps:

• Get a free API Key at https://alpha.bealore.com

• Import the library in your component:

  import { Auth, AuthProvider } from '@alore/auth-react-native-ui';
  

• Use the component in your render method:

  export default function App() {
    const config = {
      clientId: 'your-api-key',
      endpoint: 'https://api.alore.com',
      locale: 'pt',
      authMethods: {
        password: false,
        passkey: true,
        google: false,
      },
    };
    return (
      <AuthProvider config={config}>
        {/* ... Your app components or screens */}
        <Auth
          styles={customAuthStyles} // Custom styles for the Auth component
          config={{
            toast: true,
          }}
        />
      </AuthProvider>
    );
  }
  

• Customize the component as needed.

Contributing

We welcome contributions! Please follow these steps to contribute:

• Fork the repository.
• Create a new branch (git checkout -b feature/YourFeature).
• Make your changes and commit them (git commit -m 'Add some feature').
• Push to the branch (git push origin feature/YourFeature).
• Open a pull request.

License

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

Contact

If you have any questions or suggestions, feel free to reach out to bealore.com.