{"id":43136530,"url":"https://github.com/beekeeper-studio/bks-sample-plugin","last_synced_at":"2026-01-31T22:03:49.935Z","repository":{"id":282043605,"uuid":"938772862","full_name":"beekeeper-studio/bks-sample-plugin","owner":"beekeeper-studio","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-31T08:39:02.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-19T21:24:46.587Z","etag":null,"topics":["beekeeper-studio","beekeeper-studio-plugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beekeeper-studio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-25T13:33:33.000Z","updated_at":"2025-12-13T10:06:16.000Z","dependencies_parsed_at":"2025-06-08T10:36:35.858Z","dependency_job_id":null,"html_url":"https://github.com/beekeeper-studio/bks-sample-plugin","commit_stats":null,"previous_names":["beekeeper-studio/bks-sample-plugin","beekeeper-studio/bks-plugin-starter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/beekeeper-studio/bks-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fbks-sample-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fbks-sample-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fbks-sample-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fbks-sample-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beekeeper-studio","download_url":"https://codeload.github.com/beekeeper-studio/bks-sample-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fbks-sample-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28956938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T18:30:42.805Z","status":"ssl_error","status_checked_at":"2026-01-31T18:30:19.593Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["beekeeper-studio","beekeeper-studio-plugin"],"created_at":"2026-01-31T22:03:35.254Z","updated_at":"2026-01-31T22:03:49.927Z","avatar_url":"https://github.com/beekeeper-studio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Beekeeper Studio Sample Plugin\n\nA basic example of Beekeeper Studio plugin demonstrating form creation, data persistence, and cross-view communication.\n\n## Usage\n\n\u003cimg width=\"420\" height=\"212\" alt=\"image\" src=\"https://github.com/user-attachments/assets/0d5889ae-67f5-4683-878e-e97d8dab9258\" /\u003e\n\n- Submit user ratings from `Tools \u003e New Form`\n- View the data from `Tools \u003e View Summary`\n\n## Development\n\n\u003e [!NOTE]\n\u003e This example does not use a UI framework for simplicity. But if you do, it supports hot reload! Thanks to Vite's [Hot Module Replacement](https://vite.dev/guide/features.html#hot-module-replacement). :tada:\n\n\u003e [!NOTE]\n\u003e Check the browser dev tools for debugging (`Help \u003e Show Developer Tools`)\n\n### Prerequisites\n\n- Beekeeper Studio \u003e= 5.4\n- Node.js \u003e= 20.19\n\n### Setup\n\n1. Clone the repository\n   ```bash\n   git clone https://github.com/beekeeper-studio/bks-sample-plugin\n   cd bks-sample-plugin\n   ```\n\n2. Install dependencies\n   ```bash\n   yarn install\n   ```\n\n3. Create a symbolic link to the plugin directory\n   \u003e The symlink name must match the `id` field in `manifest.json`. For example, `bks-sample-plugin`.\n\n   **Linux:**\n   ```bash\n   ln -s $(pwd) ~/.config/beekeeper-studio/plugins/bks-sample-plugin\n   ```\n\n   **macOS:**\n   ```bash\n   ln -s $(pwd) \"~/Library/Application Support/beekeeper-studio/plugins/bks-sample-plugin\"\n   ```\n\n   **Windows:**\n   ```cmd\n   mklink /D \"%APPDATA%\\beekeeper-studio\\plugins\\bks-sample-plugin\" \"%CD%\"\n   ```\n\n   **Windows (Portable version):**\n   ```cmd\n   mklink /D \"/path/to/beekeeper-studio/beekeeper-studio-data/plugins/bks-sample-plugin\" \"%CD%\"\n   ```\n\n4. **Start development server**\n   ```bash\n   yarn dev\n   ```\n\n5. **For production build**\n   ```bash\n   yarn build\n   ```\n\n## Releasing \u0026 Publishing your plugin\n\n### 1.a. Automated Release\n\nThis repository contains Github Actions workflow that automates the release process by pushing a tag prefixed with `v`:\n\n1. Push a version tag\n   ```bash\n   git tag v1.0.0\n   git push origin v1.0.0\n   ```\n\n2. Once the GitHub Action completes, go to your repository's Releases page\n3. Find the release\n4. Mark it as \"Latest release\"\n\n### 1.b. Manual Release\n\nIf you don't have the GitHub Actions workflow set up:\n\n1. Build the plugin\n   ```bash\n   yarn build\n   ```\n\n2. Create the plugin archive\n   \u003e The name format is `\u003cpluginId\u003e-\u003cversion\u003e.zip`\n\n   ```bash\n   zip -r bks-sample-plugin-1.0.0.zip dist/\n   ```\n\n4. Go to your repository on GitHub\n5. Click \"Releases\" → \"Create a new release\"\n6. Tag the release with the version, for example, `v1.0.0` (prefixed with `v`)\n7. For assets, attach the current `manifest.json` and the zip file\n8. Fill the title and description\n9. Click \"Publish release\"\n\n### 2. Publishing to Plugin Registry \n\nTo make your plugin discoverable in Beekeeper Studio's plugin manager:\n\n1. Fork the plugins registry at [beekeeper-studio/beekeeper-studio-plugins](https://github.com/beekeeper-studio/beekeeper-studio-plugins)\n\n2. Add your plugin to plugins.json\n   ```json\n   {\n     \"id\": \"bks-sample-plugin\",\n     \"name\": \"Sample Plugin\",\n     \"author\": \"Your Name\",\n     \"description\": \"A sample plugin demonstrating form creation, data persistence, and cross-view communication in Beekeeper Studio\",\n     \"repo\": \"yourusername/bks-sample-plugin\"\n   }\n   ```\n\n3. Submit a pull request to [beekeeper-studio/beekeeper-studio-plugins](https://github.com/beekeeper-studio/beekeeper-studio-plugins)\n4. Once approved \u0026 merged by our team, your plugin will be available in Beekeeper Studio for public\n\n## Support\n\n- **Documentation**: Visit the [Plugin Development Guide](https://docs.beekeeperstudio.io/plugin_development/)\n- **Community Slack**: Join the [Beekeeper Studio Community](https://www.beekeeperstudio.io/slack)\n- **Issues**: Report bugs or request features in the [main repository](https://github.com/beekeeper-studio/beekeeper-studio/issues)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeekeeper-studio%2Fbks-sample-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeekeeper-studio%2Fbks-sample-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeekeeper-studio%2Fbks-sample-plugin/lists"}