Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Hugos68/capkit
CLI to integrate Capacitor into SvelteKit
https://github.com/Hugos68/capkit
capacitor cli cross-platform mobile-development node svelte sveltekit
Last synced: about 2 months ago
JSON representation
CLI to integrate Capacitor into SvelteKit
- Host: GitHub
- URL: https://github.com/Hugos68/capkit
- Owner: Hugos68
- License: mit
- Created: 2023-09-21T20:13:34.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-01T14:30:26.000Z (8 months ago)
- Last Synced: 2024-07-10T16:40:26.617Z (2 months ago)
- Topics: capacitor, cli, cross-platform, mobile-development, node, svelte, sveltekit
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/capkit
- Size: 326 KB
- Stars: 38
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://choosealicense.com/licenses/mit/)
# CapKit
The 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.
## Table of Contents
- [CapKit](#capkit)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Build](#build)
- [API](#api)
- [Capacitor](#capacitor)
- [Examples](#examples)
- [Issues](#issues)
- [License](#license)
# Installation
Before 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.
To get started with the CLI you can simply go into your existing sveltekit project and run:
npm:
```bash
npx capkit init
```
pnpm:
```bash
pnpm dlx capkit init
```
yarn:
```bash
yarn dlx capkit init
```
bun:
```bash
bunx capkit init
```
Upon 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.
# Usage
## Development
When working with native applications and using their respective IDE's (Android Studio or Xcode) you can enable hot reloading by running:
npm:
```bash
npm run dev:cap
```
pnpm:
```bash
pnpm dev:cap
```
yarn:
```bash
yarn dev:cap
```
bun:
```bash
bun dev:cap
```
If you are solely focusing on creating a progressive web app you can run:
npm:
```bash
npm run dev
```
pnpm:
```bash
pnpm dev
```
yarn:
```bash
yarn dev
```
bun:
```bash
bun dev
```
## Build
When building to native platforms you can use:
npm:
```bash
npm run build:cap
```
pnpm:
```bash
pnpm build:cap
```
yarn:
```bash
yarn build:cap
```
bun:
```bash
bun build:cap
```
If you are solely focusing on building a progressive web app you can run:
npm:
```bash
npm run build
```
pnpm:
```bash
pnpm build
```
yarn:
```bash
yarn build
```
bun:
```bash
bun build
```
## API
CapKit 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:
```ts
import { initializeProject, type Options } from 'capkit';
const options: Options = {
appName: 'My App',
appId: 'com.myapp',
platforms: ['android', 'ios'],
plugins: ['clipboard', 'push-notifications'] // See a full list of plugins here: https://capacitorjs.com/docs/apis
};
initializeProject(options);
```
# Capacitor
For further questions about Capacitor you can refer to the [Capacitor Docs](https://capacitorjs.com/docs).
# Examples
Here is a example project of a SvelteKit app with Capacitor deployed to Vercel: https://capkit-vercel.vercel.app/
Repository: https://github.com/Hugos68/capkit-vercel
# Issues
If 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.
# License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.