Skip to content

appbaseio/reactivesearch-playground

Repository files navigation

Reactivesearch Playground

A web playground which makes it easy for developers to work with Appbase.io REST API.

Features

  • ✨ Context-aware autocompletion & error highlighting
  • 🚥 Easy embeddability

Commands

TSDX scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /example.

The recommended workflow is to run TSDX in one terminal:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run the example playground:

Example

Then run the example inside another:

cd example
npm i # or yarn to install dependencies
npm start # or yarn start

The default example imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

How to use

Upon visiting the 🔗 playground, the below interface is displayed: image

  • 1: The url input takes the endpoint url of your indexed dataset.
  • 2: Use the query editor area to input your reactivesearch/ elasticsearch queries.
  • 3: Use the optional header area to pass any required/ optional headers with the query request.
  • 4: The response area displays the response fetched, after clicking the Play button, which is used to fire the query.
  • 5: Optionally, one can copy the cURL command for the processed query.
  • 6: Share functionality enables to share the current state of your playground. image
  • 7: Settings lets one edit various playground settings. image

An example

Click here to check the example live:

image

Packages

 
 
 

Contributors

Languages