A framework for creating simple applications that find VIVO profiles relevant to content in the user's browser.
##Demo To learn more about VIVO Searchlight apps and try out an application created with The Searchlight Framework, check out our about page.
##Installation
- Install node.js version 0.8.12
$ git clone http://git.github.com/ragle/searchlight$ cd searchlight$ npm install
##Quick Start
For more detailed help getting started, check out our quick start tutorial.
Create a very simple bookmarklet to host the client side app:
<html>
<head></head>
<body>
<h1>My Great Searchlight App!</h1>
<p> Drag the link below to your browser's bookmark bar to install the bookmarklet!</p>
<a href="javascript:(function(){var bar=document.getElementById('vivoSearchLightFrame');if(!bar){bar=document.createElement('div');bar.setAttribute('id','vivoSearchLightFrame');document.getElementsByTagName('body')[0].appendChild(bar);var script=document.createElement('SCRIPT');script.type='text/javascript';script.src='127.0.0.1:3000/javascripts/loader.js';document.getElementsByTagName('head')[0].appendChild(script)}else if(bar.toggle!==undefined){bar.toggle()}})();">VIVO Searchlight</a>
</body>
</html>Add the bookmarklet to your browser's bookmarklet bar, then start the app:
$ cd path/to/searchlight
$ node app.jsNavigate to the page of your choice (perhaps a news article about some research topic that interests you), and click on the bookmarklet.
You should see "No matching VIVO profiles were found" in the app UI (you haven't set up a search index yet). In your console (where you started the server), you should see the main content of the article you sent.
Congrats, you've just processed your first VIVO searchlight request, from start to finish.
Have a look at the documentation for more details about building VIVO searchlight apps.
##Documentation There is detailed documentation available here. Please submit a pull request on the gh-pages branch of this repository if you find any documentation errors. The Markdown version of the docs can be found here.
##Issues, Problems and Bugs If you find a bug, please log an issue and submit a patch. If you run into a problem you can't solve, have questions, or are interested in having a searchlight app built for your organization - please don't hesitate to get in touch!
The Searchlight Framework is currently a prototype in the earliest stages of development. It has been used to deploy a simple demo, and a proof-of-concept app for the Agrivivo Project. Your mileage may vary using it to create production apps.
##License Searchlight is available under a Creative Commons Attribution 3.0 License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent