{"id":18319367,"url":"https://github.com/hugos68/capkit","last_synced_at":"2025-04-05T21:33:32.726Z","repository":{"id":196194305,"uuid":"694844722","full_name":"Hugos68/capkit","owner":"Hugos68","description":"CLI to integrate Capacitor into SvelteKit","archived":false,"fork":false,"pushed_at":"2024-02-01T14:30:26.000Z","size":334,"stargazers_count":41,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T15:18:17.155Z","etag":null,"topics":["capacitor","cli","cross-platform","mobile-development","node","svelte","sveltekit"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/capkit","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/Hugos68.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2023-09-21T20:13:34.000Z","updated_at":"2024-11-19T00:10:06.000Z","dependencies_parsed_at":"2024-01-15T13:23:39.506Z","dependency_job_id":"98e6b513-a9d7-4cb7-9f04-4b9125b78e4a","html_url":"https://github.com/Hugos68/capkit","commit_stats":null,"previous_names":["hugos68/capkit"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hugos68%2Fcapkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hugos68%2Fcapkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hugos68%2Fcapkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hugos68%2Fcapkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hugos68","download_url":"https://codeload.github.com/Hugos68/capkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406076,"owners_count":20933803,"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":["capacitor","cli","cross-platform","mobile-development","node","svelte","sveltekit"],"created_at":"2024-11-05T18:13:08.308Z","updated_at":"2025-04-05T21:33:31.890Z","avatar_url":"https://github.com/Hugos68.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg width=\"125\" src=\"https://github.com/Hugos68/sveltekit-capacitor/assets/63101006/3b8324ff-f27d-48a3-a74d-f7aabb2f530e\" /\u003e\n\u003cimg width=\"125\" src=\"https://github.com/Hugos68/capkit/assets/63101006/cb12fccf-b42a-46ac-98fc-70cdf8cdf344\" /\u003e\n\u003cimg width=\"150\" src=\"https://github.com/Hugos68/sveltekit-capacitor/assets/63101006/e748ecc6-2a2d-4dd5-95c2-4ff4cf8a307b\" /\u003e\n\n---\n\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)\n![GitHub last commit](https://img.shields.io/github/last-commit/hugos68/capkit)\n![npm](https://img.shields.io/npm/v/capkit)\n![npm](https://img.shields.io/npm/dt/capkit)\n\n# CapKit\n\nThe CapKit CLI is a command-line interface that simplifies the process of configuring Capacitor with SvelteKit. With CapKit, you can quickly set up Capacitor for your SvelteKit app, making it easy to build and deploy native mobile applications as well as progressive web apps.\n\n## Table of Contents\n\n- [CapKit](#capkit)\n  - [Table of Contents](#table-of-contents)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Development](#development)\n  - [Build](#build)\n  - [API](#api)\n- [Capacitor](#capacitor)\n- [Examples](#examples)\n- [Issues](#issues)\n- [License](#license)\n\n# Installation\n\nBefore installing CapKit, be aware that building native applications requires you to use [Adapter Static](https://kit.svelte.dev/docs/adapter-static) because of the way Capacitor works. If you are only building a progressive web app you can use any adapter you want.\n\nTo get started with the CLI you can simply go into your existing sveltekit project and run:\n\nnpm:\n\n```bash\nnpx capkit init\n```\n\npnpm:\n\n```bash\npnpm dlx capkit init\n```\n\nyarn:\n\n```bash\nyarn dlx capkit init\n```\n\nbun:\n\n```bash\nbunx capkit init\n```\n\nUpon doing this, you will be guided through a series of questions to help you configure your project optimally. These questions will allow you to tailor the setup to your specific requirements.\n\n# Usage\n\n## Development\n\nWhen working with native applications and using their respective IDE's (Android Studio or Xcode) you can enable hot reloading by running:\n\nnpm:\n\n```bash\nnpm run dev:cap\n```\n\npnpm:\n\n```bash\npnpm dev:cap\n```\n\nyarn:\n\n```bash\nyarn dev:cap\n```\n\nbun:\n\n```bash\nbun dev:cap\n```\n\nIf you are solely focusing on creating a progressive web app you can run:\n\nnpm:\n\n```bash\nnpm run dev\n```\n\npnpm:\n\n```bash\npnpm dev\n```\n\nyarn:\n\n```bash\nyarn dev\n```\n\nbun:\n\n```bash\nbun dev\n```\n\n## Build\n\nWhen building to native platforms you can use:\n\nnpm:\n\n```bash\nnpm run build:cap\n```\n\npnpm:\n\n```bash\npnpm build:cap\n```\n\nyarn:\n\n```bash\nyarn build:cap\n```\n\nbun:\n\n```bash\nbun build:cap\n```\n\nIf you are solely focusing on building a progressive web app you can run:\n\nnpm:\n\n```bash\nnpm run build\n```\n\npnpm:\n\n```bash\npnpm build\n```\n\nyarn:\n\n```bash\nyarn build\n```\n\nbun:\n\n```bash\nbun build\n```\n\n## API\n\nCapKit also exposes an API to allow you to use it programmatically. This can be useful if you want to integrate CapKit into your own tooling or if you want to extend CapKit's functionality, you can use it like this:\n\n```ts\nimport { initializeProject, type Options } from 'capkit';\n\nconst options: Options = {\n\tappName: 'My App',\n\tappId: 'com.myapp',\n\tplatforms: ['android', 'ios'],\n\tplugins: ['clipboard', 'push-notifications'] // See a full list of plugins here: https://capacitorjs.com/docs/apis\n};\n\ninitializeProject(options);\n```\n\n# Capacitor\n\nFor further questions about Capacitor you can refer to the [Capacitor Docs](https://capacitorjs.com/docs).\n\n# Examples\n\nHere is a example project of a SvelteKit app with Capacitor deployed to Vercel: https://capkit-vercel.vercel.app/\nRepository: https://github.com/Hugos68/capkit-vercel\n\n# Issues\n\nIf you encounter any issues or have concerns, please take a moment to [report them](https://github.com/Hugos68/capkit/issues/new). Your feedback is greatly appreciated and improves the quality of CapKit.\n\n# License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugos68%2Fcapkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugos68%2Fcapkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugos68%2Fcapkit/lists"}