How shipshapecode/shepherd works
Project type and purpose
• This is a monorepo for an open-source library (Shepherd.js) that provides a digital adoption platform (DAP) core, framework wrappers (React, Ember, Vue, Angular), documentation site, and a marketing landing page. It uses pnpm workspaces to manage multiple packages and sites in one repository.
File structure
• Root: configuration (ESLint, Prettier, GitHub Actions), release scripts, workspace definitions (pnpm-workspace.yaml).
• /shepherd.js: the core library source, build (Rollup), Babel config, errors, utils, components, tours.
• /packages/react: React wrapper around Shepherd core, built with Vite, test suite (Vitest/Jest).
• /docs-src: Documentation site built with Astro, guides, API docs, MDX, deployed (Fly.toml).
• /landing: Marketing landing page using Astro, content, images, styles, routing.
• /test: End-to-end (Cypress) and unit tests (Jest) verifying core and wrapper behavior.
README for additional insights
• Shepherd core is framework-agnostic and supports multiple frameworks via wrappers.
• There is a commercial license option but this repo is the OSS edition.
• Emphasizes usage, integration points, demos, and contribution guidelines.