https://github.com/obrok/wiki-search

https://github.com/obrok/wiki-search

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/obrok/wiki-search
• Owner: obrok
• License: epl-1.0
• Created: 2015-12-13T17:45:29.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-13T18:01:46.000Z (about 9 years ago)
• Last Synced: 2024-06-14T01:20:17.233Z (7 months ago)
• Language: Clojure
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# wiki-search

This project exposes a simple JSON API to search for wiki articles by abstract

and title.

## Prerequisites

You'll need a working installation of Elasticsearch >= 1.4.0

## Installation

1. Clone the repo

1. lein deps

1. lein storage:create

1. lein seed - this will download a wiki data dump and index it, it's a lengthy

   operation but it streams the file, so you can stop it at any time and what

   got indexed up to that point will stay there

1. lein ring server

## Usage

To create the elasticsearch index

    $ lein storage:create

To destroy the elasticsearch index

    $ lein storage:destroy

To fill out the index

    $ lein seed

To start the app (see [lein-ring](https://github.com/weavejester/lein-ring) for

more information)

    $ lein ring server

To run tests - note you'll also need your elasticsearch setup for this

    $ lein test

To query the running server

    $ curl localhost:3000/search?q=Afghanistan

    {"q":"Afghanistan","results":[{"title":"Wikipedia: Queens of Afghanistan","url":"https:\/\/en.wikipedia.org\/wiki\/Queens_of_Afghanistan","abstract":"}}"} ...

## Options

You can customize the elasticsearch endpoint by setting an environment variable

    $ ELASTICSEARCH="http://127.0.0.1:9200" lein test

When running the seed operation you can select a wiki dump file to fetch

    $ DUMP_FILE="http://dumps.wikimedia.org/enwiki/latest/enwiki-latest-abstract23.xml" lein seed

## License

Copyright © 2015 Pawel Obrok

Distributed under the Eclipse Public License either version 1.0 or (at

your option) any later version.