Skip to content

Latest commit

 

History

History
125 lines (78 loc) · 5.75 KB

README.md

File metadata and controls

125 lines (78 loc) · 5.75 KB
Raw

Askless for Flutter

Build Flutter Apps with PostgreSQL, MySQL, or any database, stream data changes through websockets effortlessly, and handle websocket authentication like a pro

🌟 If you want to build your Flutter App without Firebase and stream data from a database (like SQL) to the Flutter App, Askless will save you a lot of time!

This is the Flutter side, click here to access the Backend side in Node.js

Built with Askless

Check the example of a Flutter Chat App with PostgreSQL / MySQL databases and Node.js.

commented_askless_example.mp4

🔊 The video above contains audio, click on the right side to turn it on

Why Askless?

💪 Stream data from PostgreSQL, MySQL or other database to your Flutter App through websockets

The Askless Framework (Backend in Node.js) is designed to make your Flutter App stream data in without Firebase, create your own routes that interact with your database, call route.notifyChanges(..) when something changes so the users will receive the changes!

✈️ Skip websocket details and focus in your application!

Askless Design is a result of thorough analysis to make websockets in Flutter easy and productive. It can be tricky to build websockets to transport data from a database from scratch for your Flutter App:

❕ you need to add logic to handle different kinds of data that will move through the websockets

❕ Authentication events come first, so you don't want to your client receive data he doesn't have permission to.

❕ If the websockets disconnect, either because of the user device or because of the server, we need to try to connect back again as soon as possible

❕ Ops! The user was receiving data by websockets, but he lost connection for a second and connected again, now we need to handle authentication BEFORE sending data again

❕ We may want to know once the user started streaming data and when the user received data, so we can know data was received, so an additional event like "message_received" needs to be added and handled in the App and backend, more work to simply add a double-check icon in your chat app once the message is delivered

✅ You don't need to mull over implementing these details anymore 😀 Askless is here to make your life easier!

Important links

Examples

Getting Started

The "Getting Started" is an example of the Flutter client, an example is executed locally.

1 - First create the server, click here and follow the server instructions in the section "Getting Started"

2 - (Optional) To use an unencrypted connection in a test environment such as this example (ws:// connection instead of wss://) follow these instructions. Do not apply this on a production environment.

3 - Install

pubspec.yaml:

dependencies:
  flutter:
    sdk: flutter
    
  # Add this line:
  askless: ^3.1.1

4 - Import the package

import 'package:askless/askless.dart';

5 - Initialize informing the server URL with port (default: 3000). You can also access the myAsklessServer.localUrl attribute on your server-side in node.js to discover what the local URL of your server is.

6 - Start Askless with AsklessClient.instance.start()

Example:

void main() {
  AsklessClient.instance.start(serverUrl:"ws://192.168.0.8:3000"); // TODO: replace with the URL of your Askless Server
  runApp(MyApp());
}

7 - Here we go! Now you can start using building your Flutter App with Askless, check the documentation and examples!

Issues

Feel free to open an issue about:

  • ❔ questions

  • 💡 suggestions

  • 📄 documentation improvements

  • 🐜 potential bugs

Thanks

Thank you for using Askless!

Thanks also ALL the developers who developed the libraries that Askless rely on and the authors of these two very good articles! A Comprehensive Guide to Flutter WebRTC and Flutter-WebRTC: A Complete Guide.

License

MIT