Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.4 KB

README.md

File metadata and controls

32 lines (22 loc) · 1.4 KB
Raw

overview-plugin-metadata

Edit metadata in a view.

This Overview plugin uses nothing but flat files. Any web server can serve it.

Running on a dev machine

  1. Run overview-server's ./dev 1.Run ./dev` in this directory, in a separate shell.
  2. In Overview (http://localhost:9000), create a plugin with url https://localhost:3334 and Overview URL http://overview-dev.

Then there are the tests:

  1. ./integration-tests/run runs integration tests (assuming you're running the dev-mode processes)
  2. ./integration-tests/run-browser spec/multi_search_spec.rb runs tests in a web browser viewed with vncviewer (assuming you're running the dev-mode processes)
  3. ./integration-tests/run-in-docker-compose runs a clean test environment (useful for continuous integration)

Releasing and deploying

  1. Run ./integration-tests/run-in-docker-compose
  2. ./release 1.0.1 (or whatever version) to publish a Docker image
  3. AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=... S3_BUCKET=... ./deploy to deploy to an S3 bucket. (The production version is s3://overview-plugin-metadata.overviewdocs.com.)

License

This project is copyright (c) 2017 Overview Services Inc. It's released under the AGPL-3.0 open source license. See LICENSE for legal prose.