Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (52 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.37 KB
Raw

Flutter Searchbox Contribution Guide 🔍

Welcome to the contribution guide! We welcome all contributions. You can see the list of open issues over here. If you're interested in picking up something, feel free to start a discussion 😺

The searchbox monorepo contains the code for the headless core(searchbase) and the searchbox UI widgets for flutter(flutter_searchbox). Project specific README files are available inside each package.

Initial setup

  1. Fork the repository in order to send PRs

  2. Clone the repo from your profile, use SSH if possible. Read more about it over here.

  3. cd into the project directory

  4. Checkout the master branch (should be default)

  5. Install flutter SDK. Please follow the instructions mentioned at here.

Searchbase

  • Searchbase dart code is located at here.

  • To run an example follow the below steps:

  1. cd into the example
cd searchbase/example/basic
  1. Install dependencies
flutter pub get
  1. Activate webdev
flutter pub global activate webdev
  1. Run the example
webdev serve

The web examples depend relatively on the searchbase package so you can make the changes in the lib and test on the fly.

Note: If you see any issue while running the example please check the installation guide for dart web.

Flutter Searchbox

  • Flutter searchbox provides ready-to-use UI widgets to build search UIs for flutter apps. It uses the searchbase library to manage the state of the active search widgets.

  • It is located at here.

  • If you want to watch for the changes in the searchbase lib then use a relative path instead of the direct dependency at here.

  • To run an example follow the below steps:

  1. cd into the example
cd flutter_searchbox/example
  1. Open ios simulator
Open -a Simulator.app
  1. Install dependencies
flutter pub get
  1. Run the example
flutter run