search

commonsearch / cosr-participation

Common Search sub-project to make contributing easy and help people get involved.
7 stars 0 forks source link

Add an example app built on the API #10

Open sylvinus opened 8 years ago

sylvinus commented 8 years ago

We could either use cosrlib or just the HTTP API.

It would be great to open the door to further hacks, with a small tutorial.

justinormont commented 8 years ago

There's many ways one could build an example search app.

May I recommend a hello-world-level simple example app would run a query, and display the results. The SDK would handle the communication w/ the server. A thin SDK can handle the communication and optionally add instrumentation (like providing a callback to the UI, called when the user clicks a result).

The example app would be HTML + CSS + JS. The JS calls the SDK to query and displays the results on the page.

The UI portion of a judgement platform can be build by modifying the example app. The main difference in creating a judgement platform is that you'll want to randomly order the results (to remove positional bias) then let the judge select a score (likely 0,1,2,3 where 0=bad) and send the judgements to the server.