How stuburger/yafl works
Project type and purpose
• This is an open-source, monorepo-managed JavaScript/TypeScript library for building forms in React (“yafl”) plus a static documentation site (“docs”) built with Docusaurus.
• Key goals: publish a reusable UI library to npm/unpkg and provide an online documentation/demo site via GitHub Pages or a similar host.
File structure
• Top level: configuration files (.eslintrc, tsconfig.base.json, lerna.json), CI config (.travis.yml), package.json, LICENSE, README.
• packages/yafl: the core library (source in TSX, tests, Rollup config, tsconfig).
• packages/docs: a Docusaurus site (docs, blog, src pages, docusaurus.config.js, package.json).
Extract key architecture elements from README
• React-based form library with hook APIs (useForm, useField, etc.).
• Published artifacts: UMD + ES modules bundles, type definitions.
• Hosted demo/docs at https://stuburger.github.io/yafl/.
• CI via Travis CI, deployment to npm and GitHub Pages, bundle size badge via unpkg.
Main components
A. Monorepo root
• Lerna orchestrator
• Shared config: ESLint, Prettier, tsconfig.base.json
• CI pipeline (Travis CI)
B. Package “yafl” (Core Library)
• Source code (TSX under packages/yafl/src)
• Test suite (Jest under packages/yafl/__tests__)
• Rollup build (rollup.config.js → outputs UMD & ES modules)
• npm registry (publishes package.json → npm & unpkg)
C. Package “docs” (Documentation Site)
• Docusaurus source (packages/docs/docs, blog, src/pages)
• Build scripts (docusaurus.config.js)
• Static assets (packages/docs/static)
• Hosting (GitHub Pages or equivalent)
D. External services
• GitHub (repository hosting + Pages for docs)
• Travis CI (continual integration & deployment)
• npm registry / unpkg (library distribution)
Relationships and data flows
• Developers push code → GitHub
• GitHub triggers Travis CI
• Travis runs lint, tests (yafl), then build:
• Rollup compiles “yafl” → publish to npm/unpkg
• Docusaurus builds “docs” → deploy to GitHub Pages
• docs site imports the “yafl” package (locally during development or via npm in CI) to render live demos.
Architectural patterns & design principles
• Monorepo with Lerna for multi-package management
• Component library + static site generator (Docusaurus)
• CI-driven continuous deployment
• Separation of concerns: core API vs. documentation/presentation