How mff-uk/dataspecer works
Major System Components
• Applications: Represented by the “applications” directory, these are the various web client projects (for example, the API specification app, the conceptual model editor, the data specification editor, and the manager). They interact with users via UIs developed in frameworks like React and Vite.
• Services / Backend: Under “services/backend” you have the core backend service that handles storage (the database/db file and the stores directory) and implements APIs, routes, and business logic (including Prisma migrations and REST endpoints). Incorporate its dependencies to external systems.
• Packages: The “packages” folder contains many utilities and domain-specific libraries (e.g., core-v2, csv, ldkit, opneapi, rdfs-adapter, sgov-adapter, etc.). These packages fulfill various roles: implementing domain logic, performing artifact generation, processing data specifications, and handling adapters for different data formats.
• Infrastructure & DevOps: Components such as Docker (with Dockerfile, docker-compose details), Turborepo, npm workspaces, and Cloudflare Pages (as referenced in the README) are part of the orchestration and deployment process.
Important Architectural Patterns
• And annotate any middleware or integration points (e.g., communication with external services like Cloudflare Pages or the use of Docker for containerized deployment).
• Where configuration and environment settings are made available (for instance, the use of environment variables such as BASE_URL, and user configurations for Docker).