README.md

overview-word-cloud

Shows the most common words in a document set. Larger words are more common than smaller words.

This is a plugin for Overview. You can see it live on https://www.overviewdocs.com, or in the video below:

https://www.youtube.com/watch?v=Et6F9Zerr44

Developing

Setup

1. Download and run Overview's ./dev. This creates the overviewserver_default Docker network that this plugin depends on in development mode.
2. In a separate console, git clone https://github.com/overview/overview-word-cloud.git
3. cd overview-word-cloud
4. ./dev starts a server that listens on http://localhost:3334
5. Test it within Overview:
   1. Browse to http://localhost:9000
   2. Create a document set by uploading files
   3. In the resulting Document Set, click "Add View" ... "Custom"
   4. Set Name: Word Cloud, App URL: http://localhost:3334, and Overview’s URL from App server: http://overview-web

Development Loop

1. Run ./integration-tests/run to make sure integration tests work. (You must be running Overview's ./dev and this project's ./dev for integration tests to pass.
2. Write a new test; write accompanying code; make sure tests pass.

Deploying

Run ./release 1.0.1. This will:

• Modify package.json to have the new version number
• Tag and push v1.0.1 to GitHub
• docker build . -t overview/overview-file-browser:1.0.1 and push the change

TODO: deploy automatically, via Jenkins

Now update your deployed cluster (e.g., ECS) to use the new version.

License

This project is copyright Overview Services Inc. and released under the AGPL-3.0 open source license. See LICENSE for legal prose.