talksik/fl-query
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reademes updated with new banner

Browse Source 
Notice board added
This commit is contained in:
Kingkor Roy Tirtho
2022-07-13 10:11:02 +06:00
parent 115b9e5f5d
commit 2a75aefb0f
5 changed files with 19 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -3
View File
@@ -1,6 +1,4 @@
<p align="center">
<image alt="Fl-Query Logo" width=300 src="/assets/fl-query-logo.svg"/>
</p>
!["Fl-Query Logo"](assets/fl-query-banner.png)
<h1>
<p align="center">
Fl-Query
@@ -151,3 +149,10 @@ Yes but it is only if your commercial server has huge load of power & you're mad
**So `FutureProvider` from riverpod or provider not enough?**
Yeah, indeed its more than enough for many applications but what if your app needs Optimistic Updates & proper server-state synchronization or simply want a custom `cacheTime`? Although `FutureProvider` is a viable solution most of the `Future` related stuff, why not kick it up a notch with smart refetching capabilities with proper server-state synchronization?
Riverpod is definitely a inspiration for Fl-Query & the `QueryJob` is actually inspired by riverpod & imo is the best state management solution any library has ever provided but that's still a client state manager just like other client state manager or synchronous data manager
# Notice Board
This project is currently under heavy development & not yet production ready. There are lot of features to cover. If anyone encounters any unintended behavior or any bug please report it. Also we're open to improvement suggestions & feature requests
**Important!:** The project needs Dart-Flutter developers who are willing to contribute to the project by writing Tests. (I'm the worst example for tester)
assets/fl-query-banner.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

docs/README.md
+2 -40
View File
@@ -1,41 +1,3 @@
# Website
# Docs for Fl-Query
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This documentation is based on Docusaurus2 & React
packages/fl_query/README.md
+8 -3
View File
@@ -1,6 +1,4 @@
<p align="center">
<image alt="Fl-Query Logo" width=300 src="https://user-images.githubusercontent.com/61944859/177823630-c4e885c2-29c5-4549-af79-3e5d87c06be9.svg"/>
</p>
!["Fl-Query Logo"](https://user-images.githubusercontent.com/61944859/178648225-611d248b-df97-4f0d-b298-b178bb141a29.png)
<h1>
<p align="center">
Fl-Query
@@ -151,3 +149,10 @@ Yes but it is only if your commercial server has huge load of power & you're mad
**So `FutureProvider` from riverpod or provider not enough?**
Yeah, indeed its more than enough for many applications but what if your app needs Optimistic Updates & proper server-state synchronization or simply want a custom `cacheTime`? Although `FutureProvider` is a viable solution most of the `Future` related stuff, why not kick it up a notch with smart refetching capabilities with proper server-state synchronization?
Riverpod is definitely a inspiration for Fl-Query & the `QueryJob` is actually inspired by riverpod & imo is the best state management solution any library has ever provided but that's still a client state manager just like other client state manager or synchronous data manager
# Notice Board
This project is currently under heavy development & not yet production ready. There are lot of features to cover. If anyone encounters any unintended behavior or any bug please report it. Also we're open to improvement suggestions & feature requests
**Important!:** The project needs Dart-Flutter developers who are willing to contribute to the project by writing Tests. (I'm the worst example for tester)
packages/fl_query_hooks/README.md
+1 -3
View File
@@ -1,6 +1,4 @@
<p align="center">
<image alt="Fl-Query Logo" width=300 src="https://user-images.githubusercontent.com/61944859/177823630-c4e885c2-29c5-4549-af79-3e5d87c06be9.svg"/>
</p>
![Fl-Query Banner](https://user-images.githubusercontent.com/61944859/178648225-611d248b-df97-4f0d-b298-b178bb141a29.png)
<h1>
<p align="center">
Fl-Query Hooks