{"id":15649710,"url":"https://github.com/johannschopplich/nuxt-kql","last_synced_at":"2025-04-07T13:08:41.046Z","repository":{"id":37387135,"uuid":"501997046","full_name":"johannschopplich/nuxt-kql","owner":"johannschopplich","description":"🫧 Kirby's Query Language API for Nuxt","archived":false,"fork":false,"pushed_at":"2025-02-19T12:44:40.000Z","size":3737,"stargazers_count":42,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T13:18:50.303Z","etag":null,"topics":["kirby-cms","kirby-plugin","kirby4","kirby5","nuxt","nuxt-module"],"latest_commit_sha":null,"homepage":"https://nuxt-kql.byjohann.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johannschopplich.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://paypal.me/jschopplich"]}},"created_at":"2022-06-10T10:18:07.000Z","updated_at":"2025-02-19T12:44:44.000Z","dependencies_parsed_at":"2023-10-16T12:48:32.547Z","dependency_job_id":"4beba3d5-aace-4d46-b88c-a494bde74021","html_url":"https://github.com/johannschopplich/nuxt-kql","commit_stats":{"total_commits":583,"total_committers":3,"mean_commits":"194.33333333333334","dds":"0.0034305317324184736","last_synced_commit":"53d957fac62f96f2d7726e890c83d8e8a8504587"},"previous_names":[],"tags_count":167,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johannschopplich%2Fnuxt-kql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johannschopplich%2Fnuxt-kql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johannschopplich%2Fnuxt-kql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johannschopplich%2Fnuxt-kql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johannschopplich","download_url":"https://codeload.github.com/johannschopplich/nuxt-kql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kirby-cms","kirby-plugin","kirby4","kirby5","nuxt","nuxt-module"],"created_at":"2024-10-03T12:31:12.815Z","updated_at":"2025-04-07T13:08:41.029Z","avatar_url":"https://github.com/johannschopplich.png","language":"TypeScript","funding_links":["https://paypal.me/jschopplich"],"categories":[],"sub_categories":[],"readme":"[![Nuxt KQL module](./docs/public/og.jpg)](https://nuxt-kql.byjohann.dev)\n\n# Nuxt KQL\n\n[Nuxt](https://nuxt.com) module for [Kirby's Query Language](https://github.com/getkirby/kql) API.\n\n- [✨ \u0026nbsp;Release Notes](https://github.com/johannschopplich/nuxt-kql/releases)\n- [📖 \u0026nbsp;Read the documentation](https://nuxt-kql.byjohann.dev)\n\n## Features\n\n- 🔒 Protected Kirby credentials when sending queries\n- 🪢 Supports token-based authentication with the [Kirby Headless plugin](https://github.com/johannschopplich/kirby-headless) (recommended)\n- 🤹 No CORS issues!\n- 🍱 Handle request just like with the [`useFetch`](https://nuxt.com/docs/getting-started/data-fetching/#usefetch) composable\n- 🗃 Cached query responses\n- 🦦 [Multiple starter kits](https://nuxt-kql.byjohann.dev/guide/starters) available\n- 🦾 Strongly typed\n\n## Setup\n\n\u003e [!TIP]\n\u003e [📖 Read the documentation](https://nuxt-kql.byjohann.dev)\n\n```bash\nnpx nuxi@latest module add kql\n```\n\n## Basic Usage\n\n\u003e [!TIP]\n\u003e [📖 Read the documentation](https://nuxt-kql.byjohann.dev)\n\nAdd the Nuxt KQL module to your Nuxt config:\n\n```ts\n// `nuxt.config.ts`\nexport default defineNuxtConfig({\n  modules: ['nuxt-kql']\n})\n```\n\nAnd send queries in your template:\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nconst { data, refresh, error, status, clear } = await useKql({\n  query: 'site'\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003ch1\u003e{{ data?.result?.title }}\u003c/h1\u003e\n    \u003cpre\u003e{{ JSON.stringify(data?.result, undefined, 2) }}\u003c/pre\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n## 💻 Development\n\n1. Clone this repository\n2. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`\n3. Install dependencies using `pnpm install`\n4. Run `pnpm run dev:prepare`\n5. Start development server using `pnpm run dev`\n\n## License\n\n[MIT](./LICENSE) License © 2022-PRESENT [Johann Schopplich](https://github.com/johannschopplich)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannschopplich%2Fnuxt-kql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohannschopplich%2Fnuxt-kql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannschopplich%2Fnuxt-kql/lists"}