75 lines
2.8 KiB
Markdown
75 lines
2.8 KiB
Markdown
# Example App: Integrating with Reflex Platform
|
|
|
|
## Purpose
|
|
|
|
This repository contains an example Flutter application demonstrating how to integrate with the Reflex Platform, a powerful tool developed by Hardis Group. This example app showcases how to leverage the Reflex Platform's APIs to build custom integrations and extend the capabilities of your warehouse management system.
|
|
|
|
Whether you're a developer looking to understand how to interact with Reflex Platform's services or a business seeking to evaluate the integration potential, this example app provides a hands-on starting point. It makes use of the [Reflex Platform Dart SDK](https://git.reflex-platform.com/reflex-platform/dart-core-sdk) to demonstrate how to fetch data, and perform key operations within the Reflex Platform ecosystem.
|
|
|
|
## Features
|
|
|
|
- Demonstrates basic integration with Reflex Platform APIs.
|
|
- Illustrates authentication flows and API request patterns.
|
|
- Serves as a template for building more complex integrations.
|
|
|
|
## Getting Started
|
|
|
|
To get started with this example Flutter app, follow the steps below:
|
|
|
|
### 1. Clone the Repository
|
|
|
|
First, clone this repository to your local machine using the following command:
|
|
|
|
```bash
|
|
git clone https://git.reflex-platform.com/reflex-platform/flutter-rp-example
|
|
cd flutter-rp-example
|
|
```
|
|
|
|
### 2. Obtain a Reflex Platform Client ID
|
|
|
|
This example app requires a Reflex Platform client ID for authentication purposes. To obtain this, you need to get in contact with a Hardis representative. The representative will provide you with a unique `RP_AUTH_CLIENT_ID` that you'll use to authenticate API requests.
|
|
|
|
### 3. Configure the Application
|
|
|
|
Once you have your `RP_AUTH_CLIENT_ID`, you'll need to replace the placeholder value in the application with your actual client ID.
|
|
|
|
1. Open the project's configuration file, typically named `lib/globals.dart`.
|
|
2. Locate the line that defines `RP_AUTH_CLIENT_ID`:
|
|
|
|
```dart
|
|
const String RP_AUTH_CLIENT_ID = 'your_client_id_here';
|
|
```
|
|
|
|
3. Replace `'your_client_id_here'` with the client ID you received from Hardis.
|
|
|
|
### 3. Run the Application
|
|
|
|
With the configuration in place, you can now run the Flutter application. Use the following commands:
|
|
|
|
1. Ensure you have all the necessary dependencies installed:
|
|
|
|
```bash
|
|
flutter pub get
|
|
```
|
|
|
|
2. Run the application on your preferred device or emulator
|
|
|
|
```bash
|
|
flutter run
|
|
```
|
|
|
|
### 4. Explore and Extend
|
|
|
|
Once the application is running, explore the provided features and examine the code to understand how the integration with Reflex Platform works. You can use this example as a foundation to build more complex and tailored integrations for your specific use case.
|
|
|
|
## Requirements
|
|
|
|
* Flutter
|
|
* Android
|
|
* Android Studio
|
|
* iOS
|
|
* Xcode
|
|
* Cocoapods
|
|
|
|
## License
|
|
Distributed under the MIT [License](LICENSE). See `LICENSE` for more information. |