https://github.com/caido/starterkit-plugin

🔰 Caido Plugin StarterKit
https://github.com/caido/starterkit-plugin

caido starter-kit typescript

Last synced: about 2 months ago
JSON representation

🔰 Caido Plugin StarterKit

• Host: GitHub
• URL: https://github.com/caido/starterkit-plugin
• Owner: caido
• License: cc0-1.0
• Created: 2024-03-29T16:39:11.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T21:00:52.000Z (about 2 months ago)
• Last Synced: 2024-10-24T08:59:34.547Z (about 2 months ago)
• Topics: caido, starter-kit, typescript
• Language: TypeScript
• Homepage:
• Size: 32.2 KB
• Stars: 30
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  


  


  Website

    •  

  Dashboard

    •  

  Docs

    •  

  Roadmap

    •  

  Branding

    •  

  Discord

  


  




# 🔰 StarterKit Plugin

This is the starter kit for the Caido plugin system.

This template is full-stack, with both a backend and frontend plugin. This is called a `plugin package`.

For frontend only use the [frontend](https://github.com/caido/starterkit-plugin-frontend) starterkit.

## 🏎️ Usage

1. `pnpm install`

1. Make some modifications in `src`

1. `pnpm build`

1. Upload the `plugin_package.zip` in the `dist` folder to your Caido instance

## 🗒️ Release

The Github Action `release` can be used to create a release of your `plugin package`.

> If you want to sign your `plugin package`, you need an ed25519 private key named `PRIVATE_KEY` in your Github Action secrets.

To release your plugin to the store, you have to follow a set of operations. Please check out our documentation on the subject.