Skip to content

About

used for testing our embeddable tools

Resources

Stars

2 stars

Watchers

5 watching

Forks

Repository files navigation

testing-ground

A stable environment to test ShareYourPaper outside our normal infrastructure. Each page is a mock library website that loads the embed with one set of institution settings (config). GitHub Pages serves them at https://oaworks.github.io/testing-ground/<path>, with no build step: changes pushed to master go live within a minute or two.

Layout

  • shareyourpaper/dev/: the dev embed (dev.shareyourpaper.org/embed.js) against the beta API. Tests use these.
  • shareyourpaper/live/: the live embed, mostly copies of real institutions’ set-ups.

Pages used by Ghost Inspector

All tests below are in the ShareYourPaper Website suite, which runs daily.

Page Config Tests
dev/default owner dark deposit (library default), go back (general), redeposit (library default)
dev/default-with-owner owner url update on entry & restart (embed)
dev/community owner, community AAM upload to community
dev/pilot-mode-on owner, pilot pilot mode
dev/with-policy owner, ror oa policy response override

Adding a page

Copy a page in shareyourpaper/dev/ and change its config. Use example.edu for any addresses or links. Add the page to the table above once a Ghost Inspector test uses it.

Running locally

From the repo root:

python3 -m http.server 8000

Then open e.g. http://localhost:8000/shareyourpaper/dev/default.html. Include .html, which GitHub Pages lets you leave out.

To try unreleased embed code, also run python3 -m http.server 8001 in a shareyourpaper checkout, and point a page’s script tag at http://localhost:8001/content/embed.js. Change it back before committing. Ghost Inspector runs in the cloud, so it can only test the GitHub Pages copy.

About

used for testing our embeddable tools

Resources

Stars

2 stars

Watchers

5 watching

Forks

Contributors

Languages