Skip to content

Commit

Permalink
Merge branch 'master' of github.com:fogbeam/Neddick
Browse files Browse the repository at this point in the history
  • Loading branch information
mindcrime committed Sep 18, 2013
2 parents 246d02f + 25a66fb commit 48ecf99
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,47 @@
Neddick
========

Neddick - an Open Source Information Discovery Platform - is part of the Fogcutter suite of tools for building intelligent applications. Neddick provides tools for tagging, ranking, discussing and discovering various sources of knowledge: web-links, documents, people, etc.
Neddick is an Open Source Information Discovery Platform, which shares an approach to information discovery with
consumer facing websites like [Reddit](http://www.reddit.com), [Digg](http://www.digg.com), and other aggregator
applications. Neddick makes up one component of the [Fogcutter Suite](http://code.google.com/p/fogcutter) and is
based on Groovy & Grails.

Neddick could be termed "Reddit for the Enterprise" but that would be oversimplifying a bit. Neddick
is intended mainly for organizational use and therefore has features that Reddit lacks, but, in turn,
lacks certain things that Reddit has. But Reddit was absolutely our inspiration for Neddick and you'll
notice the commonality almost immediately.


Why "Neddick?"
----------------

We like lighthouses, so Neddick is named after the famous Cape Neddick "Nubble" Lighthouse.

Ok, but what does it do?
--------------------------

This is over-simplifying a little bit, but think of Neddick as sort of a combination of Reddit, Delicious and Planet. Mix in a powerful search engine, and a recommendations engine, and it lets you categorize, rate, tag, filter, discuss, and discover the knowledge in ways that most enterprise search applications can't. Point Neddick at the RSS feed coming from your Document Management System, feed it some web-links, post some questions, tag some article, vote some things up or down, and let Neddick help you discover the knowledge you need, even if you didn't know you were looking for it.

Features
----------

Summary of already implemented features. To see Neddick in action, visit [the demo site](http://demo.fogbeam.org:8080/neddick1/).
Relative to Reddit, Neddick adds features like:

* Channels can subscribe to RSS feeds - any "channel" in Neddick (roughly equivalent to a Sub-Reddit on Reddit) can link to 0 or more RSS feeds, and the channel will automatically be populated from those feeds on a scheduled basis.
* Tags - Neddick supports the application of arbitrary tags to entries, and provides each user a view of the tags they have used, to enable rapid access to specific content.
* Channel Filters - Filters allow you to filter your view of a channel based on criteria including: body keyword, title keyword, score, and tags.
* More powerful "sharing" capability - Neddick supports sharing content by email, XMPP, and HTTP POST.
* ActivityStrea.ms support - Neddick can HTTP POST entries to remote endpoints in [ActivityStrea.ms format](http://www.activitystrea.ms). This is how we built our integration with [Quoddy](http://code.google.com/p/quoddy) - the Enterprise Social Network component of the Fogcutter Suite.
* Channel Triggers - Triggers allow a user to specify actions to occur when Entry related events occur which match criteria which may include: A new Entry is posted which matches a body keyword or title keyword, an Entry is voted up past a specified score threshold, or a specified tag is applied to an Entry.
* Trigger actions include sharing via email, XMPP and HTTP post, and in future releases will be extend to include sending JMS messages, launching workflows via BPM integration, and running user provided scripts.

To see Neddick in action, visit [the demo site](http://demo.fogbeam.org:8080/neddick/). (login: testuser1/secret)

Building & Deploying Neddick
----------

Instructions for deploying the latest release can be found at:

https://github.com/fogbeam/Neddick/releases/tag/v0.0.0-tpr4

Once the app is up and running, you can login using testuser1/secret as the username/password pair.


Roadmap
----------
Expand Down

0 comments on commit 48ecf99

Please sign in to comment.