How tractorjuice/onlinewardleymaps works
Project type and purpose
• This is primarily a client-side, React-based single-page application (SPA) called OnlineWardleyMaps. It parses and renders Wardley Maps in the browser, and is also packaged as a VSCode extension. In addition, it includes a Jekyll-generated documentation site under docs/.
• The README confirms that this is the source for www.OnlineWardleyMaps.com, supports local development (yarn start), production builds (yarn build), Storybook demos, tests, and packaging for VSCode (yarn package).
File structure
Top-level partitions:
• Config & tooling
– .github/workflows/main.yml: CI/CD pipeline
– babel.config.js, config-overrides.js, jest.config.js: compilation and test setup
– .prettierrc.json, .eslintrc.json: linting & formatting
• Documentation site (docs/)
– Jekyll layout, pages, posts, assets → statically hosted via GitHub Pages or CDN
• Public assets (public/)
– index.html, manifest.json, robots.txt → entry point for the React SPA
– mode-owm.js: optional OpenWeatherMap integration
• React application (src/)
– UI components under src/components/ (editor, map, symbols, actions, contexts)
– Conversion engine under src/conversion/ (extraction strategies, Converter.js, migrations)
– Linking strategies under src/linkStrategies/
– Core renderers under src/MapElements.js, src/MetaPositioner.js
– Constants (src/constants/), styles (src/styles.scss), entry point (src/index.js)
– Tests under src/__tests__/ and component snapshots
• VSCode extension package (wmlandscape/)
– Rollup config (wmlandscape/rollup.config.js)
– Its own package.json, Babel config, and src/index.js for extension entry
README for additional insights
• Confirms tech stack: Node.js + Yarn, React, Storybook for component demos, Jest for tests.
• No backend server – purely front-end & static hosting.
• CI/CD is likely via GitHub Actions, deploying both the SPA and Jekyll docs.