Git Product home page Git Product logo

picky's Introduction

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/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 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

picky's People

Contributors

floere avatar stanley avatar danfarino avatar tonini avatar

Stargazers

Mattias Pfeiffer avatar

Watchers

Mattias Pfeiffer avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.