{"id":29013204,"url":"https://github.com/michael-borck/electron-kit","last_synced_at":"2026-04-08T23:33:25.315Z","repository":{"id":299426658,"uuid":"1002993318","full_name":"michael-borck/electron-kit","owner":"michael-borck","description":"Modular Electron template system with TypeScript, React, and AI integration for desktop apps.","archived":false,"fork":false,"pushed_at":"2026-03-01T00:59:45.000Z","size":249,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-01T04:07:20.995Z","etag":null,"topics":["ai-integration","cross-platform","data-visualization","desktop-app","electron","electron-builder","modular-architecture","notifications","react","sqlite","tailwind-css","tailwindcss","template","tool","typescript","vector-search","vite"],"latest_commit_sha":null,"homepage":null,"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/michael-borck.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-16T13:09:16.000Z","updated_at":"2026-03-01T00:59:48.000Z","dependencies_parsed_at":"2025-06-16T14:44:10.493Z","dependency_job_id":"6c17643e-807d-4940-bd4b-9f51c4ebdd11","html_url":"https://github.com/michael-borck/electron-kit","commit_stats":null,"previous_names":["michael-borck/electron-kit","michaelborck-dev/electron-kit"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/michael-borck/electron-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-borck%2Felectron-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-borck%2Felectron-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-borck%2Felectron-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-borck%2Felectron-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michael-borck","download_url":"https://codeload.github.com/michael-borck/electron-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-borck%2Felectron-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31579055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["ai-integration","cross-platform","data-visualization","desktop-app","electron","electron-builder","modular-architecture","notifications","react","sqlite","tailwind-css","tailwindcss","template","tool","typescript","vector-search","vite"],"created_at":"2025-06-25T19:10:23.906Z","updated_at":"2026-04-08T23:33:25.310Z","avatar_url":"https://github.com/michael-borck.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron Template System\n\n\u003c!-- BADGES:START --\u003e\n[![data-visualization](https://img.shields.io/badge/-data--visualization-blue?style=flat-square)](https://github.com/topics/data-visualization) [![electron](https://img.shields.io/badge/-electron-47848f?style=flat-square)](https://github.com/topics/electron) [![electron-builder](https://img.shields.io/badge/-electron--builder-blue?style=flat-square)](https://github.com/topics/electron-builder) [![notifications](https://img.shields.io/badge/-notifications-blue?style=flat-square)](https://github.com/topics/notifications) [![react](https://img.shields.io/badge/-react-61dafb?style=flat-square)](https://github.com/topics/react) [![sqlite](https://img.shields.io/badge/-sqlite-blue?style=flat-square)](https://github.com/topics/sqlite) [![tailwind-css](https://img.shields.io/badge/-tailwind--css-blue?style=flat-square)](https://github.com/topics/tailwind-css) [![typescript](https://img.shields.io/badge/-typescript-3178c6?style=flat-square)](https://github.com/topics/typescript) [![vector-search](https://img.shields.io/badge/-vector--search-blue?style=flat-square)](https://github.com/topics/vector-search) [![vite](https://img.shields.io/badge/-vite-blue?style=flat-square)](https://github.com/topics/vite)\n\u003c!-- BADGES:END --\u003e\n\nA comprehensive, modular Electron application template system for building consistent, professional desktop applications with modern web technologies.\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.3+-blue.svg)](https://www.typescriptlang.org/)\n[![Electron](https://img.shields.io/badge/Electron-22+-green.svg)](https://www.electronjs.org/)\n[![React](https://img.shields.io/badge/React-18+-blue.svg)](https://reactjs.org/)\n\n## 🚀 Features\n\n### Core Framework\n- **🔷 TypeScript-first** - Complete type safety throughout the stack\n- **⚡ Modern Build System** - Vite + Electron Builder for fast development and optimized builds\n- **🎨 Design System** - Tailwind CSS with custom theme and dark mode support\n- **📱 Responsive Layout** - Professional desktop UI patterns with collapsible sidebars\n- **🔧 Universal Settings** - Theme, accessibility, window management, and user preferences\n- **🌍 Multi-platform** - Windows, macOS, and Linux builds with GitHub Actions CI/CD\n\n### Modular Architecture\n- **🧩 Pick Your Stack** - Include only the modules you need\n- **🔌 Plugin System** - Clean integration patterns for extending functionality\n- **📦 Self-contained Modules** - Each module is independently developed and tested\n- **🔄 Hot Reload** - Fast development experience across all modules\n\n### Advanced Modules\n- **🤖 AI Integration** - Multi-provider support (OpenAI, Claude, Gemini, Ollama)\n- **🗄️ Database** - SQLite integration with migrations and backups\n- **🔍 Vector Search** - Local semantic search with LanceDB\n- **📊 Data Visualization** - Chart.js, D3.js, and Recharts integration\n- **📄 Documentation** - Markdown rendering with search and interactive tours\n- **🔔 Notifications** - Toast, system, and progress notifications\n- **⌨️ Shortcuts** - Comprehensive keyboard shortcut management\n- **🔄 Auto-Updates** - Built-in update system with rollback support\n- **📤 Import/Export** - Multiple format support with drag-drop interface\n\n## 🏗️ Template Structure\n\n```\nelectron-template/\n├── packages/              # Core modules\n│   ├── core/             # Base Electron + React setup\n│   ├── settings/         # Universal settings system\n│   ├── ai/               # AI service integration\n│   ├── database/         # SQLite database\n│   ├── vector-search/    # Semantic search\n│   ├── charts/           # Data visualization\n│   ├── docs/             # Documentation system\n│   ├── notifications/    # Notification system\n│   ├── shortcuts/        # Keyboard shortcuts\n│   ├── updater/          # Auto-update system\n│   └── import-export/    # Data import/export\n├── templates/            # Pre-built combinations\n│   ├── basic/            # Minimal setup\n│   ├── ai-app/           # AI-focused application\n│   ├── data-app/         # Data analysis application\n│   └── full/             # Complete feature set\n└── tools/                # Development tools\n    └── create-app/       # CLI generator\n```\n\n## 🚀 Quick Start\n\n### Using the CLI Generator (Recommended)\n\n```bash\n# Create a new AI-powered application\nnpx @michaelborck/create-electron-kit my-ai-app --template=ai-app\n\n# Create a data analysis application\nnpx @michaelborck/create-electron-kit my-data-app --template=data-app\n\n# Create with all modules\nnpx @michaelborck/create-electron-kit my-full-app --template=full\n\n# Start with minimal setup\nnpx @michaelborck/create-electron-kit my-basic-app --template=basic\n```\n\n### Manual Setup\n\n```bash\n# Clone the template\ngit clone https://github.com/yourusername/electron-template.git my-app\ncd my-app\n\n# Install dependencies\nnpm install\n\n# Start development\nnpm run dev\n```\n\n## 📋 Available Templates\n\n| Template | Modules Included | Best For |\n|----------|------------------|----------|\n| **basic** | Core + Settings | Simple utilities, minimal apps |\n| **ai-app** | Core + Settings + AI + Notifications | Chat apps, AI assistants, content tools |\n| **data-app** | Core + Settings + Database + Charts + Import/Export | Analytics, reporting, data management |\n| **research-app** | Core + AI + Database + Vector Search + Docs | Research tools, knowledge management |\n| **full** | All modules | Feature-rich applications, demos |\n\n## 🧩 Available Modules\n\n### Core Modules\n\n| Module | Description | Key Features |\n|--------|-------------|--------------|\n| **@template/core** | Base Electron setup | React 18, TypeScript, Vite, Hot reload |\n| **@template/settings** | Universal settings | Theme, accessibility, persistence |\n\n### Feature Modules\n\n| Module | Description | Key Features |\n|--------|-------------|--------------|\n| **@template/ai** | AI service integration | OpenAI, Claude, Gemini, Ollama, streaming |\n| **@template/database** | SQLite database | Migrations, backups, type-safe queries |\n| **@template/vector-search** | Semantic search | LanceDB, embeddings, similarity search |\n| **@template/charts** | Data visualization | Chart.js, D3, Recharts, responsive |\n| **@template/docs** | Documentation system | Markdown, search, tours, highlighting |\n| **@template/notifications** | Notification system | Toast, system, progress, DND mode |\n| **@template/shortcuts** | Keyboard shortcuts | Global/local, recording, conflict detection |\n| **@template/updater** | Auto-update system | Background updates, rollback, channels |\n| **@template/import-export** | Data import/export | JSON, CSV, Excel, drag-drop |\n\n## 💻 Development\n\n### Prerequisites\n\n- Node.js 18+\n- npm 9+\n- Git\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/electron-template.git\ncd electron-template\n\n# Install dependencies\nnpm install\n\n# Start development mode\nnpm run dev\n```\n\n### Available Scripts\n\n```bash\n# Development\nnpm run dev              # Start development servers\nnpm run dev:web          # Web-only development\nnpm run dev:electron     # Electron development\n\n# Building\nnpm run build            # Build all packages\nnpm run build:packages   # Build packages only\nnpm run build:templates  # Build template combinations\n\n# Platform-specific builds\nnpm run build:win        # Build for Windows\nnpm run build:mac        # Build for macOS  \nnpm run build:linux      # Build for Linux\n\n# Quality assurance\nnpm run test             # Run all tests\nnpm run test:unit        # Unit tests only\nnpm run test:e2e         # End-to-end tests\nnpm run lint             # ESLint check\nnpm run lint:fix         # Fix linting issues\nnpm run type-check       # TypeScript check\nnpm run format           # Prettier formatting\n\n# Utilities\nnpm run clean            # Clean build artifacts\nnpm run reset            # Reset all dependencies\n```\n\n## 📚 Documentation\n\n- **[USAGE.md](./USAGE.md)** - Comprehensive usage guide with examples\n- **[ACKNOWLEDGMENTS.md](./ACKNOWLEDGMENTS.md)** - Open source attributions\n- **Module Documentation** - Each package includes detailed README\n- **Example Applications** - See `templates/` directory for working examples\n\n## 🛠️ Module Integration Example\n\n```tsx\nimport React from 'react'\nimport {\n  SettingsProvider,\n  AIProvider,\n  DatabaseProvider,\n  NotificationProvider\n} from '@template/core'\nimport { ChatInterface } from './components/ChatInterface'\n\nfunction App() {\n  return (\n    \u003cSettingsProvider\u003e\n      \u003cDatabaseProvider\u003e\n        \u003cAIProvider\u003e\n          \u003cNotificationProvider\u003e\n            \u003cdiv className=\"app\"\u003e\n              \u003cChatInterface /\u003e\n            \u003c/div\u003e\n          \u003c/NotificationProvider\u003e\n        \u003c/AIProvider\u003e\n      \u003c/DatabaseProvider\u003e\n    \u003c/SettingsProvider\u003e\n  )\n}\n\nexport default App\n```\n\n## 🚢 Deployment\n\n### Automated Builds\n\nGitHub Actions automatically builds for all platforms when you push tags:\n\n```bash\ngit tag v1.0.0\ngit push origin v1.0.0\n```\n\n### Manual Builds\n\n```bash\n# Build for current platform\nnpm run build\n\n# Build for all platforms\nnpm run build:all\n\n# Build and publish\nnpm run release\n```\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature/amazing-feature`\n3. Make your changes and add tests\n4. Ensure all tests pass: `npm run test`\n5. Commit your changes: `git commit -m 'Add amazing feature'`\n6. Push to the branch: `git push origin feature/amazing-feature`\n7. Open a Pull Request\n\n### Development Guidelines\n\n- **TypeScript**: All code must be properly typed\n- **Testing**: Add tests for new features\n- **Documentation**: Update relevant documentation\n- **Accessibility**: Follow WCAG 2.1 AA guidelines\n- **Performance**: Consider bundle size and runtime performance\n\n## 🐛 Troubleshooting\n\n### Common Issues\n\n**Build fails with native dependencies:**\n```bash\nnpm run electron:rebuild\n```\n\n**TypeScript errors:**\n```bash\nnpm run type-check\n```\n\n**Module resolution issues:**\n```bash\nnpm run clean \u0026\u0026 npm install\n```\n\nFor more troubleshooting help, see [USAGE.md](./USAGE.md#troubleshooting).\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\nThis template system builds upon many excellent open source projects. See [ACKNOWLEDGMENTS.md](ACKNOWLEDGMENTS.md) for the complete list of attributions.\n\n---\n\n**Built with ❤️ for the Electron community**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael-borck%2Felectron-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichael-borck%2Felectron-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael-borck%2Felectron-kit/lists"}