webiny/data-mock

webiny-Profil

Letzte erfasste Quellaktivität: 24. September 2026 um 16:34

SkillsMP-Katalog aktualisiert: 26. Oktober 2026 um 11:37

gesammelte Skills: 10

GitHub-Stars: 1
GitHub-Forks: 0

README des Repositorys

README-Quelldatei: README.md

README-Quelldatei lesen

Vollständige README anzeigen

# Webiny Data Mock A multi-project tool for generating and seeding mock data into Webiny CMS instances. Manages project connections (encrypted), syncs models/groups/tenants from live Webiny, generates realistic fake data respecting CMS field validation, and sends entries via GraphQL. Includes a CLI, REST API, and web UI. ## Quick Start ### 1. Install dependencies ```bash yarn install ``` ### 2. Initialize environment ```bash yarn cli init ``` This generates a `.env` file with a random encryption key and default port config: ``` ENCRYPTION_KEY=<64-char hex> API_PORT=4000 UI_PORT=4001 ``` ### 3. Add a project **Option A: Via CLI** ```bash yarn cli add-project ``` Prompts for project name, Webiny API URL, API token, tenant, and version. **Option B: Via seed file (recommended for teams)** Create `.projects.json` in the project root: ```json [ { "name": "My Webiny Project", "apiUrl": "https://your-api.webiny.com", "apiToken": "your-api-token", "tenant": "root", "webinyVersion": "6.0.0" } ] ``` Projects are upserted by name on every server start. The API token is encrypted before storage. See `.projects.json.example` for the format. > **Important:** `.projects.json` contains real API tokens — it is gitignored. Never commit it. Only `.projects.json.example` with placeholder values is tracked. ### 4. Start the dev server ```bash yarn dev ``` This starts both the API server (port 4000) and the UI (port 4001) with hot reload. Open **http://localhost:4001** in your browser. ### 5. Set up a project If not already seeded via `.projects.json`, add a project: 1. Click **Add Project** on the project list page 2. Enter project name, Webiny API URL, API token, tenant, and version ### 6. Pull tenants and models Before seeding or importing, the project needs tenants and models pulled from Webiny: 1. Open the project 2. Go to **Pull Tenants** — click **Pull Tenants** to discover tenants from the Webiny instance 3. For each tenant other than the default one, set its API token in the **Tenants** tab (**Edit token**). The environment's API token is the main key and only works for the default (root) tenant. 4. Go to **Pull Models** — click **Pull Models** to pull CMS model definitions and groups for every tenant that has a key. Models are stored per tenant. These must be done in order — tenants first, then tokens, then models. After pulling, the tenants and models tabs show what was discovered. ### 7. Seed data or import existing entries **Option A: Seed new mock data** 1. Go to **Seed Data** 2. Select a **target tenant** 3. Set **entries per model** and **revisions** (e.g. `1` or `1-5` for a random range) 4. Select which models to seed (grouped by content model group) 5. Optionally override entries/revisions per model 6. Choose a **publish strategy** (none, all, random %, first revision, last revision) 7. Optionally enable **unpublish cycles** (simulates real content lifecycle) 8. Click **Seed Data** — a confirmation dialog shows all settings and lets you adjust **batch size** (concurrent mutations) 9. Confirm to start the job **Option B: Import existing entries from Webiny** 1. Go to **Import** to pull existing entries from the Webiny instance into the local audit log 2. Imported entries become available as refs for future seed runs All operations run as background jobs with real-time progress via WebSocket. Check the **Jobs** tab for status, logs, and to cancel running jobs. ### Key concepts - **Dependency ordering**: models with ref fields are seeded after the models they reference — e.g. `productCategory` seeds before `product` - **Available refs**: all previously seeded and imported entries are available for ref fields, so you can seed categories in one run and products in another - **Batch size**: controls how many GraphQL mutations run concurrently (1–50). Higher = faster but more load on Webiny - **Fail fast**: if a mutation fails for a model, seeding stops for that model and moves to the next - **Rate limiting**: automatic retry on HTTP 429 with exponential backoff (up to 3 retries) ## CLI Usage | Command | Description | |---|---| | `yarn cli init` | Generate `.env` with encryption key + port config | | `yarn cli add-project` | Add a Webiny project interactively | | `yarn cli list-projects` | Show all configured projects | | `yarn cli remove-project` | Select + confirm + remove a project | | `yarn cli pull-models` | Pull models/groups from a Webiny project | | `yarn cli seed` | Generate + send mock entries (select project → tenants → models → amounts) | | `yarn cli rotate-key` | Rotate the API token encryption key | | `yarn cli upload-files` | Upload files to a Webiny project's file manager | ## Architecture ``` CLI (src/cli/) → shared services (src/shared/node/) API (src/api/) → shared services UI (src/ui/) → API via HTTP + WebSocket ``` - **Shared layer** (`src/shared/node/`): SQLite persistence, GraphQL client, generators, job execution - **API layer** (`src/api/`): Fastify REST + WebSocket server - **UI layer** (`src/ui/`): React + Mantine + MobX - **DI**: `@webiny/di` container with abstractions/implementations pattern ### Background Jobs All long-running operations (seed, sync, import, cleanup) run as background jobs: 1. API route enqueues a job → returns 202 with job ID 2. JobWorker polls every 3s, picks up pending jobs, runs executor 3. Progress + logs pushed to UI via WebSocket in real-time 4. UI shows toast notification on completion/failure 5. Affected data auto-refreshes in the UI Job types: `seed`, `pull-tenants`, `pull-models`, `cleanup`, `import`. ### Audit Log Every seeded entry is logged with: - **Request**: full GraphQL mutation, variables, URL (auth token redacted) - **Response**: complete raw HTTP response from Webiny - **Error**: error message if the mutation failed Click any entry in the Audit Log tab to see the full request/response detail. ## Development | Script | Command | Purpose | |---|---|---| | `yarn dev` | `concurrently` | API + UI together | | `yarn cli` | `tsx src/cli/entry.ts` | CLI tool | | `yarn api:dev` | `tsx --watch src/api/entry.ts` | API server only | | `yarn ui:dev` | `vite dev` | UI dev server only | | `yarn typecheck` | `tsc --noEmit` | Type checking | | `yarn test` | `vitest run` | Run tests | | `yarn test:watch` | `vitest` | Watch mode | | `yarn lint` | `oxlint` | Lint check | | `yarn format:check` | `oxfmt --check` | Format check | | `yarn db:generate` | `drizzle-kit generate` | Generate DB migration | **Before every commit:** `yarn lint && yarn format:check && yarn typecheck && yarn test` ## Environment Variables | Variable | Required | Default | Purpose | |---|---|---|---| | `ENCRYPTION_KEY` | Yes | — | 64-char hex for AES-256-GCM token encryption | | `API_PORT` | No | 4000 | Fastify server port | | `UI_PORT` | No | 4001 | Vite dev server port | | `DB_PATH` | No | `.webiny/data-mock.db` | SQLite database path | ## Runtime Data All runtime data is stored in `.webiny/` (gitignored): ``` .webiny/ ├── data-mock.db # SQLite database ├── cache/ # File cache └── logs/ # Log files ``` ## Project Seed File `.projects.json` is read on every server start. Projects are matched by name — existing projects are updated, new ones are inserted. This is the recommended way to share project connections across a team (each developer creates their own `.projects.json` from the example). ```bash cp .projects.json.example .projects.json # Edit .projects.json with your real values ```

README des Repositorys wird geladen…

Skills in diesem Repository

Softwareentwickler Softwarequalitätssicherungsanalysten und -tester Web- und digitale Schnittstellendesigner Webentwickler

4 Berufskategorien · 50% klassifiziert

Webentwickler

Use when building UI features in src/ui/. Layered architecture: Gateway (HTTP) → Repository (state) → UseCase (logic) → Presenter (MobX vm) → React (display). React is dumb. All state and logic in TypeScript classes via DI. Invoke BEFORE writing any UI code.…

Quellsprache: Englisch

2026-09-04

Es werden 10 von 10 gesammelten Skills angezeigt.

Mit einem KI-Assistenten installieren

Diesen Prompt kopieren und in den verwendeten KI-Assistenten einfügen.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/webiny/data-mock.