Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arichiardi/wiki-search-xml
A very simple implementation of a Clojure app to search wiki xmls
https://github.com/arichiardi/wiki-search-xml
Last synced: 22 days ago
JSON representation
A very simple implementation of a Clojure app to search wiki xmls
- Host: GitHub
- URL: https://github.com/arichiardi/wiki-search-xml
- Owner: arichiardi
- License: mit
- Created: 2015-05-28T07:57:01.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-03T05:17:18.000Z (almost 7 years ago)
- Last Synced: 2024-10-22T13:56:22.222Z (2 months ago)
- Language: Clojure
- Homepage:
- Size: 4.9 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Search wikipedia XML repository #
An implementation of a Clojure webapp to search wiki abstracts using ```core.async```.
The app leverages [Apache Commons Daemon](https://commons.apache.org/proper/commons-daemon/) and therefore can be launched with the lenghty:
- ```/usr/bin/jsvc -debug -server -cwd `pwd` -pidfile ~/tmp/wiki-search-xml-daemon.pid -user $USER -cp `pwd`/target/wiki_search_xml-**$VERSION**-standalone.jar wiki_search_xml.daemon```
After having executed the classic:
- ``` lein uberjar``` or ```lein with-profile dev uberjar```
The app will be waiting for calls to its ```/search``` api on port ```7501```, like so:
- ```http://127.0.0.1:7501/search?q=blatnaya```
Finally, to test run:
- ```lein midje```
- ```lein midje :filter -slow``` to exclude slow tests
- ```lein midje :filter -network``` to exclude network tests that might fail if offline
where:
- ```(go)``` starts up the system (network binding included)
- ```(stop)``` stops it
- ```(reset)``` refreshes the clj files and restarts
## TODOs
- Add persistency on db
- Handle async responses (```http-kit``` websocket/long-polling)
- Add connection with external replicas (through ```RabbitMQ```)
## Bootstrap
- [reloadable-app](https://github.com/mowat27/reloadable-app)
## Framework
- [component](https://github.com/stuartsierra/component)
- [Luminus](http://www.luminusweb.net)
- [Luminus Doc](http://www.luminusweb.net/docs)
- [lib-noir](https://github.com/noir-clojure/lib-noir)
- [ring wiki](https://github.com/ring-clojure/ring/wiki)
- [compojure wiki](https://github.com/weavejester/compojure/wiki)
- [Interactive dev](https://github.com/ring-clojure/ring/wiki/Interactive-Development) -> will use ```component``` reset and ```reloadable-app```
- [http-kit](http://www.http-kit.org/)
As I won't require any frontend, I went for a stable and solid framework that is based on ```ring```'s reliabilty and simplicity.
I was also tempted by [this other template](https://github.com/borkdude/lein-new-liberagent) but it looked a bit overkill for what I want to implement.
## Test Driven Development
- [Midje](https://github.com/marick/Midje)
- [Midje wiki](https://github.com/marick/Midje/wiki)
- [Midje introduction](https://github.com/marick/Midje/wiki/A-tutorial-introduction)
- [lein-midje](https://github.com/marick/lein-midje)
- [Clojure-jump-to-file](https://github.com/marick/Midje/wiki/Clojure-jump-to-file)
- [midje-notifier](https://github.com/glittershark/midje-notifier)
I decided to experiment TDD using ```Midje``` instead of ```clojure.test``` for two reasons: it looks more flexible and interactive (have a look at midje-notifier).
## DB
- [Couchdb Docs](http://docs.couchdb.org/en/1.6.1)
- [Couchdb on Ubuntu](https://launchpad.net/~couchdb/+archive/ubuntu/stable)
## Other libraries (might be useful or not)
- [org.clojure/data.xml](https://github.com/clojure/data.xml)-> xml/parse is lazy and can handle efficienty huge .xml files
- [Cheshire](https://github.com/dakrone/cheshire)
- [Aleph](https://github.com/ztellman/aleph)
- [Compojure-API](https://github.com/metosin/compojure-api)
## Other resources
- [Langohr on heroku](https://devcenter.heroku.com/articles/queuing-in-clojure-with-langohr-and-rabbitmq)
- [Heroku & Docker (beta)](https://blog.heroku.com/archives/2015/5/5/introducing_heroku_docker_release_build_deploy_heroku_apps_with_docker)