Skip to content
This repository
tag: v0.11.2
Fetching contributors…

Cannot retrieve contributors at this time

file 82 lines (44 sloc) 2.233 kb

Picky

The Ruby small-text search engine.

Take a dive with Picky in the Getting Started section.
Find everything else in the Picky Wiki.

Installation

Note that Picky only runs on Ruby 1.9. I recommend RVM for installing and managing Ruby versions.

gem install picky picky-client

The server

The server generates a library example, which you can run right away.

# Generates a directory "app_name"
# with a new Picky project.

picky project app_name
cd app_name
bundle install

Index the data

rake index

Start the Picky server

rake start

Try a query!

curl localhost:8080/books/full?query=test

Don’t worry about the strange looking results! The next part (client) will take care of them.

If you’re interested anyway: Results

The client

The client generates an example app for the “library” example backend, using Sinatra.

# Generates a directory "app_name"
# with a new Picky Client Webapp project.

picky-client sinatra app_name
cd app_name
bundle install

Start the app server

unicorn -p 3000

Admire your work

Go to http://localhost:3000/ and try the examples.

Your own search

You’re probably itching to change the example for your own data. How do you do this?

The server

In the server directory, just type

rake

and it will tell you where to change the server configuration.

The client

Go to http://localhost:3000/configure and the page will show you how to configure your app server.

Need help?

Right here. I’m happy to help! If something doesn’t work, send/gist me your application.rb and I’ll look into it.

github, twitter, mail

Something went wrong with that request. Please try again.