|
1 | | -# :bird: flutter_feathersjs :bird: |
| 1 | +# :bird: flutter_feathersjs :bird |
2 | 2 |
|
| 3 | +[](https://pub.dev/packages/flutter_feathersjs/score) |
| 4 | +[](https://pub.dev/packages/flutter_feathersjs/score) |
| 5 | +[](https://pub.dev/packages/flutter_feathersjs/score) |
| 6 | +[](https://github.com/dahkenangnon/flutter_feathersjs) |
| 7 | +[](https://pub.dev/packages/flutter_feathersjs) |
| 8 | +[](https://github.com/dahkenangnon/flutter_feathersjs) |
3 | 9 |
|
4 | 10 | <p align="center"> |
5 | 11 | <img width="460" alt="FlutterFeathersJs Icon" height="300" src="https://dahkenangnon.github.io/flutter_feathersjs.dart/assets/img/logo.png"> |
6 | 12 | <br> |
7 | 13 | Communicate with your feathers js server from flutter app with unbelieved ease and make happy your customers. |
8 | 14 | <br><br><br> |
9 | | - |
10 | | -</p> |
11 | 15 |
|
| 16 | +</p> |
12 | 17 |
|
13 | 18 | `Infos: Feathers js is a node framework for real-time applications and REST APIs.` |
14 | 19 |
|
15 | 20 | <br> |
16 | 21 |
|
17 | | -# :warning: [PLEASE CONTRIBUTE TO THESE DISCUSSIONS FOR NEXT RELEASE OF THIS PACKAGE](https://github.com/Dahkenangnon/flutter_feathersjs.dart/discussions) |
| 22 | +## Simple to use |
18 | 23 |
|
| 24 | +### 1. Install it |
19 | 25 |
|
| 26 | +```yaml |
| 27 | +# Please see https://pub.dev/packages/flutter_feathersjs/install |
| 28 | +flutter_feathersjs: ^lastest |
| 29 | +``` |
20 | 30 |
|
21 | | -## Documentation |
| 31 | +### 2. Import it |
22 | 32 |
|
23 | | -Documentation is now available from: [https://dahkenangnon.github.io/flutter_feathersjs.dart/](https://dahkenangnon.github.io/flutter_feathersjs.dart/) |
| 33 | +```dart |
| 34 | +// Import it |
| 35 | +import 'package:flutter_feathersjs/flutter_feathersjs.dart'; |
24 | 36 |
|
25 | | -## Tutorial |
| 37 | +``` |
26 | 38 |
|
27 | | -Coming tutorial at: [https://dah-kenangnon.com/](https://dah-kenangnon.com) |
| 39 | +### 3. Initialize it |
28 | 40 |
|
| 41 | +```dart |
29 | 42 |
|
30 | 43 |
|
31 | | -## Deployment |
| 44 | +//your api baseUrl |
| 45 | +const BASE_URL = "https://flutter-feathersjs.herokuapp.com"; |
32 | 46 |
|
33 | | -This package can be used in production app. |
| 47 | +// Init it globally across your app, maybe with get_it or something like that |
| 48 | +FlutterFeathersjs flutterFeathersjs = FlutterFeathersjs() |
| 49 | + ..init(baseUrl: BASE_URL); |
34 | 50 |
|
| 51 | +``` |
35 | 52 |
|
| 53 | +**You're ready to go: 3, 2, 1 :rocket:** Checkout the [doc](https://dahkenangnon.github.io/flutter_feathersjs.dart/) for more info. |
36 | 54 |
|
37 | | -## Support |
| 55 | +## Notes |
38 | 56 |
|
39 | | -Please email to dah.kenangnon@gmail.com if you have any questions or comments or business support. |
| 57 | +**:green_square: This package can be used in prod env from version** **V3.0.0** and up :rocket:. |
40 | 58 |
|
| 59 | +**:green_square: This package is tested with feathersjs v4.x** |
41 | 60 |
|
42 | | -## Contributing |
| 61 | +**:green_square: Great features will be added soonly ([Learn more here](https://github.com/Dahkenangnon/flutter_feathersjs.dart/issues/19)). These feature will introduce incompatibilities with previous versions.** |
43 | 62 |
|
44 | | -Please feel free to contribute to this project by opening an issue or creating a pull request. |
| 63 | +:green_square: Null safety supported from version V4.0.2. |
| 64 | + |
| 65 | +:green_square: See pubspec.yaml for more infos. |
45 | 66 |
|
| 67 | +## Documentation |
46 | 68 |
|
47 | | -## Project status |
| 69 | +Check it out at: [https://dahkenangnon.github.io/flutter_feathersjs.dart/](https://dahkenangnon.github.io/flutter_feathersjs.dart/) |
48 | 70 |
|
49 | | -[](https://pub.dev/packages/flutter_feathersjs/score) |
50 | | -[](https://pub.dev/packages/flutter_feathersjs/score) |
51 | | -[](https://pub.dev/packages/flutter_feathersjs/score) |
52 | | -[](https://github.com/dahkenangnon/flutter_feathersjs) |
53 | | -[](https://pub.dev/packages/flutter_feathersjs) |
54 | | -[](https://github.com/dahkenangnon/flutter_feathersjs) |
| 71 | +## Support |
| 72 | + |
| 73 | +Please email to **dah.kenangnon (at) gmail (dot) com** if you have any questions or comments or business support. |
| 74 | + |
| 75 | +## Contributing |
| 76 | + |
| 77 | +Please feel free to contribute to this project by opening an issue or creating a pull request. |
0 commit comments