Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rodrigobertotti/askless

A framework to build websocket servers for Flutter Apps that lets you update your widgets in realtime by streaming data changes with WebSockets. Create your Flutter App without Firebase, with PostgreSQL, MySQL, or any database you want, and handle WebSocket authentication
https://github.com/rodrigobertotti/askless

flutter flutterwithnodejs nodejs realtime server websocket

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/rodrigobertotti/askless
Owner: RodrigoBertotti
License: mit
Created: 2021-01-30T18:23:21.000Z (almost 4 years ago)
Default Branch: dev
Last Pushed: 2024-08-09T18:52:38.000Z (5 months ago)
Last Synced: 2024-11-16T03:27:12.212Z (about 2 months ago)
Topics: flutter, flutterwithnodejs, nodejs, realtime, server, websocket
Language: TypeScript
Homepage:
Size: 4.36 MB
Stars: 24
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Askless: **A coherent Node.js Backend for Flutter**

A framework to build websocket servers for Flutter Apps that lets you update your widgets in realtime by streaming data changes with WebSockets. Create your Flutter App without Firebase, with PostgreSQL, MySQL, or any database you want, and handle WebSocket authentication

This is the server side in Node.js,

**[click here to access the Askless Flutter Client](https://github.com/RodrigoBertotti/askless-flutter-client)**

## Built with Askless

Check the example of a [Flutter Chat App with Node.js, WebSockets and MySQL](https://github.com/RodrigoBertotti/flutter_chat_app_with_nodejs).

https://github.com/RodrigoBertotti/flutter_chat_app_with_nodejs/assets/15431956/42428123-76ab-4c5c-8ba1-29321d11b74b

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

## Important links

*  [Askless Backend in Node.js](https://github.com/RodrigoBertotti/askless) the backend side of this Flutter client

*  [Documentation](documentation.md)

*  [Askless Flutter Client](https://github.com/RodrigoBertotti/askless-flutter-client)

#### Examples

* ^Level: ^{:red_circle: :white_circle: :white_circle: :white_circle: :white_circle:} [Flutter Random Numbers Example](example/random-numbers-ts): Random numbers are generated on the server.

* ^Level: ^{:red_circle: :red_circle: :white_circle: :white_circle: :white_circle:} [Flutter Simple Chat Example](example/simple-chat-ts): Simple chat between the colors blue and green.    

* ^Level: ^{:red_circle: :red_circle: :red_circle: :white_circle: :white_circle:} [Flutter Catalog Example](https://github.com/RodrigoBertotti/askless-flutter-client/tree/dev/example/catalog): Users adding and removing products from a catalog.

* ^Level: ^{:red_circle: :red_circle: :red_circle: :red_circle: :red_circle:} [Flutter Chat App with MySQL or PostgreSQL ](https://github.com/RodrigoBertotti/flutter_chat_app_with_nodejs): A Flutter Chat App with MySQL, WebSockets, and Node.js

## Getting Started

1 - Install Askless

    npm install --save askless 

2 - Import the package

    import { AsklessServer } from "askless";

3 - Create and init the server

    const server = new AsklessServer();

    server.init({

        wsOptions: { port : 3000 }

    });

4 - Check the **[documentation](documentation.md)** and create your server first App with Askless, you can also check the **[examples](#important-links)**.

5 - Start the server

    server.start();

6 - Discover your server url on your local network:

    

    console.log(server.localUrl) 

    

Run the server, it will print something like: `ws://192.168.?.?:3000`

## Issues

Feel free to open an issue about:

- :grey_question: questions

- :bulb: suggestions

- :page_facing_up: documentation improvements

- :ant: potential bugs

## License

[MIT](LICENSE)