Giter VIP home page Giter VIP logo

meilisearch-flutter's Introduction

Meilisearch

[WIP] Meilisearch Flutter

Pub Version GitHub Workflow Status License Bors enabled

⚡ The Meilisearch UI kit for Flutter apps

Meilisearch is an open-source search engine. Learn more about Meilisearch.

Table of Contents

Description

⬆️ Back to top

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. No credit card required.

Getting started

TBD, WIP.

Installation

TBD, WIP.

⬆️ Back to top

Usage

TBD, WIP.

⬆️ Back to top

Contributing

Hey, thank you so much for wanting to contribute! Any new contribution is more than welcome in this project! Please read our contributing guidelines for detailed instructions.

⬆️ Back to top

Contact

Feel free to contact us about any questions you may have:

Any suggestion or feedback is highly appreciated. Thank you for your support!

⬆️ Back to top

License

MIT

⬆️ Back to top

meilisearch-flutter's People

Contributors

ahmednfwela avatar brunoocasali avatar curquiza avatar meili-bot avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

icnahom

meilisearch-flutter's Issues

Package design principles

These are the subjective principles I will follow when designing this package, so we can discuss them in this issue

My main inspiration for designing this package will be firebase_ui_firestore

  1. Customizability - The kit shouldn't force the user to use a specific UI design.
  2. Ease of use - The kit should provide good looking interfaces by default with minimal modification.
  3. Follow flutter design patterns - All stateful widgets SHOULD have their states exposed (for use with GlobalKey<TState>) AND have controllers (for use with model-view-controller cases like InheritedModel)
  4. Correctly typed - Widgets should be generic, and not force the user to use Map<String, dynamic>
  5. Tested - while testing UI is always hard, I will try my best to include as many meaningful tests as possible.
  6. Responsive - the package should provide UI for all types of screens, ListViews for mobile, Tables for desktop, etc ...
  7. Reactive - while the sdk currently uses Futures only, if this product discussion goes through meilisearch/product#143 , we might be getting a Stream-based API
  8. Minimize 3rd party dependencies, but not completely ignore them - Packages like https://pub.dev/packages/flutter_typeahead , and https://pub.dev/packages/infinite_scroll_pagination can be used to not reinvent the wheel

cc @brunoocasali

Package name

What name to use for the new package on pub.dev? Since we already have meilisearch, I suggest naming it meilisearch_ui

Cc @brunoocasali

Update basic information

A central issue to track everything that should be added during/after the development of the repo:

  • Correct Meilisearch + Flutter logo in the README
  • Contributing guidelines
  • Add useful information in the README:
    • How to install the library
    • How to use the library (basic concepts)
  • Add dependabot

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.