Reademes updated with new banner
Notice board added
This commit is contained in:
@@ -1,6 +1,4 @@
|
|||||||
<p align="center">
|

|
||||||
<image alt="Fl-Query Logo" width=300 src="/assets/fl-query-logo.svg"/>
|
|
||||||
</p>
|
|
||||||
<h1>
|
<h1>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Fl-Query
|
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?**
|
**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?
|
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
|
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)
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
+2
-40
@@ -1,41 +1,3 @@
|
|||||||
# Website
|
# Docs for Fl-Query
|
||||||
|
|
||||||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
This documentation is based on Docusaurus2 & React
|
||||||
|
|
||||||
### 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.
|
|
||||||
@@ -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>
|
|
||||||
<h1>
|
<h1>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Fl-Query
|
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?**
|
**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?
|
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
|
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)
|
||||||
@@ -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>
|
|
||||||
<h1>
|
<h1>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Fl-Query Hooks
|
Fl-Query Hooks
|
||||||
|
|||||||
Reference in New Issue
Block a user