https://github.com/erikgartner/ghostdoc
A smart text viewer that semi-automatically identifies, highlights and summarizes based on artifacts.
https://github.com/erikgartner/ghostdoc
wiki-engine
Last synced: 5 months ago
JSON representation
A smart text viewer that semi-automatically identifies, highlights and summarizes based on artifacts.
- Host: GitHub
- URL: https://github.com/erikgartner/ghostdoc
- Owner: ErikGartner
- Created: 2015-12-04T22:48:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-04-04T18:58:49.000Z (about 7 years ago)
- Last Synced: 2024-10-05T10:59:50.149Z (over 1 year ago)
- Topics: wiki-engine
- Language: JavaScript
- Homepage: https://gartner.io/ghostdoc/
- Size: 1.3 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Ghostdoc
*A smart text viewer that semi-automatically identifies, highlights and summarizes
based on artifacts.*
The purpose of this app is to take large texts such as articles, journals or even books and extract information regarding so-called *artifacts* (persons, places etc). That way it becomes easy for the viewer to get a summary of all relevant information about an artifact found in the source material.
## Ritter
The web app is backed by [Ritter](https://github.com/ErikGartner/ghostdoc-ritter), a python data processing engine. When the user updates a source or artifact definition a message is sent to an instance of *Ritter* that then processes the data and returns it to the web app.
*Ghostdoc* and *Ritter* instances communicates via a RabbitMQ broker and works against a shared Mongo database.
## Installation
Ghostdoc and Ritter is optimized for running on Dokku but can run anywhere that supports NodeJS and Python 3.5.
- Setup a Mongo database
- Setup a RabbitMQ broker
- Setup [Ritter](https://github.com/ErikGartner/ghostdoc-ritter)
- Set the follwing environment variables:
```
MONGO_URL
RABBITMQ_URL
ROOT_URL
```