Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Picky is a really easy to use and fast Ruby semantic search engine that helps your users find what they are looking for.
Ruby JavaScript Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
activemodel
client
diagrams
examples/simple_example
generators
live
sandbox
server
statistics
.gitignore
LICENSE
README.textile
document
history.textile
install
integration
release
specs
tag
version.rb
walkthrough.textile

README.textile

Picky

The Ruby semantic text search engine.

Take a dive with Picky in the Getting Started section on http://florianhanke.com/picky.
Ask questions in the Picky Mailing List.
See the changelog.
Find everything else in the Picky Wiki.

System Requirements

I recommend RVM for installing and managing Ruby versions.

Installation

gem install picky picky-client picky-generators

The server

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

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

picky generate unicorn_server 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?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 Sinatra Webapp project.

picky generate sinatra_client 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.