Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.79 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.79 KB
Raw

Solrstrap

Solrstrap is a Query-Result interface for Solr. Solrstrap is intended to be a starting point for those building web interfaces that talk to Solr, or a very lightweight admin tool for querying Solr in a Googleish fashion.

DOWNLOAD: Latest stable release- Solrstrap 0.3

HOMEPAGE: http://fergiemcdowall.github.com/solrstrap/

CLONE, FORK, GAZE AT CODE: https://github.com/fergiemcdowall/solrstrap/

What does Solrstrap do?

Solrstrap takes search queries and displays search results. It also features:

  • Instant search
  • Infinite scrolling
  • Facets
  • Restful interface (you can link directly to /solrstrap.html?q=doughnuts)
  • Functioning history

Solrstrap is probably the fastest available rendering engine for Solr.

This is because it does everything in Javascript, CSS and HTML on the client side. JSON is shot back from the server and interpeted by the web browser.

Solrstrap therefore requires much less server power and bandwidth than standard search-middleware applications.

Installation, How do I make it work?

Optionally edit SERVERROOT in /js/solrstrap.js to point to the "select" endpoint of your solr instance, and HITTITLE/HITBODY to reference the appropriate fields in your index

Click on /solrstrap.html.

Thats it.

What is Solrstrap made of?

Solrstrap is lovingly crafted from Bootstrap and Handlebars.

Strengths

  • Requires only local installation- very easy to set up
  • Access to all Bootstrap functionality. Can be easily extended in a Bootstrappy way.
  • Blazing fast
  • Uses very little bandwidth

Weaknesses

  • Designed for "open" solr instances- needs clear access to /select/q=.
  • SEO basically non-existant
  • Will (probably) not work on truly ancient browsers (IE 7 and below)

Future releases

  • Some form of arrow key functionality...
  • Meaningful error messages and sanity checks...
  • Nicer code

License

Copyright 2013 Fergus McDowall

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact

Follow/contact me on Twitter @fergiemcdowall

I write articles about search engine technology here: http://blog.comperiosearch.com/blog/author/fmcdowall/