Giter Club home page Giter Club logo

quixote's Introduction

Quixote

About

Quixote is the search service that powers CityShelf, a web application that makes searching for books through local and independent booksellers quick and easy.

API Endpoints

Content-Type for all requests/responses is application/JSON.

Method Path Response
GET /books/?field=value Books where field = value
GET /stores/?field=value Stores where field = value

For example,

λ curl http://localhost:8080/books/?query=Omon+Ra&latitude=40.805135&longitude=-73.964991

will return a JSON representation of all books matching the query "Omon Ra" from independent bookstores in New York City, and

λ curl http://localhost:8080/stores/?latitude=40.805135&longitude=-73.964991

will return a JSON representation of bookstores near 40.805135˚N 73.964991˚W.

We currently support Boston, Chicago, Minneapolis, New York, Portland, and Seattle.

Running Locally

Quixote is a Clojure API (generated via Enlive, Liberator, and Compojure). The overall CityShelf application is an isomorphic Clojure(Script) stack; the Cityshelf repository contains the ClojureScript web client. To run this service locally, you'll need:

  • Clojure 1.7
  • Leiningen 2

Installation

  1. Clone the repository (λ git clone [email protected]:ericqweinstein/quixote.git)
  2. Install dependencies (λ lein deps)
  3. Start the web server on port 8080 (λ lein run)

Deploying

Quixote currently lives on Heroku at http://cityshelf-api.herokuapp.com/.

  1. Test (λ lein midje)
  2. Deploy (λ git push heroku master)

Contributing

  1. Branch (λ git checkout -b fancy-new-feature)
  2. Commit (λ git commit -m "Fanciness!")
  3. Lint (λ lein lint)
  4. Test (λ lein midje)
  5. Push (λ git push origin fancy-new-feature)
  6. Ye Olde Pulle Request

Miscellaneous

You can generate documentation with λ lein doc.

License

MIT (see LICENSE).

quixote's People

Contributors

ericqweinstein avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

quixote's Issues

Implement authentication scheme

CityShelf communicates with Quixote via CORS, but Quixote doesn't yet implement an authentication scheme to ensure the requests are coming from valid/trusted sources. We should set up authentication tokens for the web and iOS front ends to pass along to prove they are permitted to make search requests.

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.