OpenTour Builder is an open-source platform for building geospatial tours that work well on phones. Tour creators add stops with locations, images, video, and text. Visitors follow the tour on a map, with directions from stop to stop.
It's built and maintained by the Emory Center for Digital Scholarship (ECDS).
- Documentation: docs.opentour.site
- ECDS's hosted service: opentour.site. To apply for a tour site, see the proposal process.
OpenTour is made of three applications, each in its own repository:
| Repository | What it is | Built with |
|---|---|---|
| otb-api-server | The API that stores tours and serves both front ends. Each tour site gets its own database schema. | Ruby on Rails, PostgreSQL |
| otb-admin-interface | Where tour creators build and publish tours. | React Router, TypeScript |
| otb-public-interface | The tours visitors see, at <tour-site>.opentour.site. |
React Router, TypeScript |
See each repository's README for setup and development instructions.
The documentation lives in docs/ as plain Markdown and is published to docs.opentour.site whenever it changes on the main branch.
To change it, edit the Markdown files, directly on GitHub or locally, and commit. New pages need a line in the nav: list in mkdocs.yml to appear in the menu. Stick to Markdown that GitHub itself displays correctly, so the files stay readable here too.
Put images in docs/images/ as PNG or JPEG, any size. When they reach main, the docs workflow shrinks them to at most 1600 pixels wide, converts them to WebP, updates the links, and commits the result. Pull before your next local edit to pick up that commit.
To preview the site locally (optional):
pip install -r requirements.txt
mkdocs serveOpenTour Builder is released under the MIT License. Please follow our Code of Conduct.