https://github.com/fal-ai/fal-dart

The fal.ai serverless client for Dart and Flutter
https://github.com/fal-ai/fal-dart

Last synced: 19 days ago
JSON representation

The fal.ai serverless client for Dart and Flutter

• Host: GitHub
• URL: https://github.com/fal-ai/fal-dart
• Owner: fal-ai
• License: mit
• Created: 2023-11-03T06:16:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-11T03:55:08.000Z (4 months ago)
• Last Synced: 2024-12-15T22:43:40.936Z (26 days ago)
• Language: Dart
• Size: 342 KB
• Stars: 9
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# The fal.ai Dart/Flutter client

![fal_client pub.dev package](https://img.shields.io/pub/v/fal_client?color=%237527D7&label=fal_client&style=flat-square)

![Build](https://img.shields.io/github/actions/workflow/status/fal-ai/fal-dart/build.yml?style=flat-square)

![License](https://img.shields.io/github/license/fal-ai/fal-dart?style=flat-square)

## About the Project

The `fal_client` is a robust and user-friendly library designed for seamless integration of fal model inference and training endpoints in Dart and Flutter projects. Developed in pure Dart, it provides developers with simple APIs to interact with AI models and works across all supported Flutter platforms.

## Getting Started

The `fal_client` library serves as a client for fal APIs. For guidance on running out inference and training APIs, refer to the [quickstart guide](https://fal.ai/docs).

### Client Library

This client library is crafted as a lightweight layer atop platform standards like `http` and `cross_file`. This ensures a hassle-free integration into your existing codebase. Moreover, it addresses platform disparities, guaranteeing flawless operation across various Flutter runtimes.

> **Note:**

> Ensure you've reviewed the [fal getting started guide](https://fal.ai/docs) to acquire your credentials and register your functions.

1. Start by adding `fal_client` as a dependency:

  ```sh

  flutter pub add fal_client

  ```

2. Setup the client instance:

  ```dart

  import 'package:fal_client/fal_client.dart';

  final fal = FalClient.withCredentials('FAL_KEY');

  ```

3. Now use `fal.subscribe` to dispatch requests to the model API:

  ```dart

  final output = await fal.subscribe('fal-ai/flux/dev',

    input: {

      'prompt': 'a cute shih-tzu puppy'

    },

    onQueueUpdate: (update) => {print(update)}

  );

  print(output.data);

  print(output.requestId);

  ```

**Notes:**

- Replace `fal-ai/flux/dev` with the model of your preference. Check [fal.ai/models](https://fal.ai/models) for all available models.

- The result type is a `FalOutput.data` and the entries depend on the API output schema.

## Roadmap

See the [open feature requests](https://github.com/fal-ai/fal-dart/labels/enhancement) for a list of proposed features and join the discussion.

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Make sure you read our [Code of Conduct](https://github.com/fal-ai/fal-dart/blob/main/CODE_OF_CONDUCT.md)

2. Fork the project and clone your fork

3. Setup the local environment with `npm install`

4. Create a feature branch (`git checkout -b feature/add-cool-thing`) or a bugfix branch (`git checkout -b fix/smash-that-bug`)

5. Commit the changes (`git commit -m 'feat(client): added a cool thing'`) - use [conventional commits](https://conventionalcommits.org)

6. Push to the branch (`git push --set-upstream origin feature/add-cool-thing`)

7. Open a Pull Request

Check the [good first issue queue](https://github.com/fal-ai/fal-dart/labels/good+first+issue), your contribution will be welcome!

## License

Distributed under the MIT License. See [LICENSE](https://github.com/fal-ai/fal-dart/blob/main/LICENSE) for more information.