# LynxHub Seamlessly install, configure, launch, and manage your AI interfaces from a single, intuitive platform. [![GitHub Release][github-release-shield]](https://github.com/KindaBrazy/LynxHub/releases) [![GitHub Release Date][github-release-date-shield]](https://github.com/KindaBrazy/LynxHub/releases) [![GitHub Downloads (all assets, all releases)][github-downloads-shield]](https://github.com/KindaBrazy/LynxHub/releases) [![Discord][discord-shield]](https://discord.gg/e8rBzhtcnK) [![GitHub Repo stars][github-repo-stars-shield]](https://github.com/KindaBrazy/LynxHub) 

🔗 Download

[!TIP] 🌟 Exclusive Early Access

Join Patreon to gain Early Access to the new features, bug fixes, and compatibilities

For more details, check out ❤️‍🔥 Support section.

🗂️ Table of Contents

• ✨ Feature Overview
• 📃 Available Modules
• 📺 Demo Video
• 🖼️ Screenshots
• 📦 Installation
• 🔧 Development
• 🤝 Contributing
• ❤️‍🔥 Support
• 💡 Acknowledgement

✨ Feature Overview

LynxHub offers a comprehensive suite of features designed to streamline your AI workflow and enhance your experience. Here's what you can expect:

• Modular Design
  • Fully modular architecture allowing third-party developers to create and publish custom modules
  • Modules can add new AI web interfaces (WebUIs) to the app, fully customizable by the developer
  • Developers can pre-define custom arguments, extensions, commands, and other configurations as part of the module, creating pre-configured WebUIs for users
• AI Interface Management
  • Install, update, and auto-update
  • Manage AI extensions with options for batch updates and auto-update settings
  • View available extensions and install them directly
• Arguments Manager
  • Available arguments list, add, remove, and edit various argument types (dropdowns, checkboxes, text input, folder/file selection - relative, absolute)
  • Search through arguments
  • Create and manage argument presets for different setups
• Custom Run Commands
  • Set and manage custom terminal commands for executing WebUI
• Pre-launch Actions
  • Automatically execute custom terminal commands before launching AI interfaces
  • Open specific files or folders as part of the pre-launch process
• Browser and Terminal Integration
  • Built-in terminal and web browser for seamless integration
  • Automatic detection and launch of relevant addresses (URLs, files)
  • Switch easily between terminal and browser modes
• AI Information Dashboard
  • View developer information, installation and update status
  • Access update tags, release notes, and disk usage statistics for each AI interface
• UI Customization
  • Customize the layout of cards for a flexible user interface
  • Dark and light themes available
  • Pin favorite AI interfaces to the home page for easy access

📃 Available Modules

🖼️ Image Generation

Developer	Project	GitHub
ComfyAnonymous	ComfyUI	Link
Patientx	ComfyUI Zluda	Link
Automatic1111	Stable Diffusion	Link
Lshqqytiger	Stable Diffusion AMDGPU	Link
Lllyasviel	SD Forge	Link
Lshqqytiger	SD Forge AMDGPU	Link
Vladmandic	SD Next	Link
McMonkeyProjects	SwarmUI	Link
Bmaltais	Kohya's GUI	Link
Anapnoe	SD UI-UX	Link
Nerogar	OneTrainer	Link
InvokeAI	InvokeAI	Link

📝 Text Generation

Developer	Project	GitHub
Oobabooga	Text Generation	Link
SillyTavern	SillyTavern	Link

🎵 Audio Generation

Developer	Project	GitHub
Rsxdalv	Text to Speech	Link
Gitmylo	Audio Generation	Link
Erew123	AllTalk TTS	Link

📺 Demo Video

🖼️ Screenshots

📦 Installation

Follow these steps to get LynxHub up and running on your system:

1. Install Git
2. Install Python (Optional for the app, required for AI interfaces)
   Recommended version: Python 3.10.11.
   • During installation, make sure to check "Add Python to PATH"
3. Install LynxHub
   Get the executable setup file from Releases page.
4. Launch the Application
5. Updating
   • LynxHub will automatically check for updates
   • If an update is available, you'll be prompted to download and install it
6. 🎉 You're All Set! Enjoy using the app!

🔧 Development

This section provides guidelines for setting up your development environment and working on LynxHub.

Prerequisites

• NodeJS (LTS version recommended)
• Git

Setting Up the Development Environment

1. Clone the repository:

   git clone https://github.com/KindaBrazy/LynxHub
   cd LynxHub

2. Install dependencies:

   npm i

3. Start the development environment:

   npm run dev

   This will launch the app in development mode with the following features:

   • Hot Reload: Changes in the renderer process will automatically refresh the app.
   • Auto Restart: Changes in the main process will automatically restart the app.

Development Hotkeys

• F12: Open DevTools
• CTRL + R: Refresh the renderer (while DevTools is focused)

Native Modules

Native modules are automatically detected and compiled after installation.(postinstall)

Building and Packaging

To package the app for distribution:

1. For Windows:

   npm run build:win

2. For other platforms: Modify the BuilderConfig file to target different platforms, then run:

   npm run build

🤝 Contributing

As a solo developer, I'm thrilled by and deeply appreciate any contributions to this project! Your involvement, no matter how big or small, plays a crucial role in improving and growing this application. All types of contributions are welcome and valued!

🌟 Ways to Contribute

1. 💻 Contributing Code:
   • Feel free to tackle any open issues or implement new features.
2. 🧩 Developing Modules:
   • Interested in creating a module? Great! Check out Module-Guide for guidelines.
   • This is an excellent way to extend the app's functionality.
3. 💡 Suggesting Enhancements:
   • Have an idea to make the app better? I love to hear it!
   • Open an issue with the tag "enhancement" and describe your proposal.

Remember, every contribution counts! Whether it's a typo fix or a major feature, your effort is deeply appreciated and helps make this project better for everyone. Thank you for being a part of this journey!

❤️‍🔥 Support

Your support is crucial in keeping this project alive and thriving! If you find value in this app and want to contribute to its growth, consider becoming a Patron.

By becoming a patron, you'll unlock a range of exclusive perks:

• 🚀 Early Access: Be the first to experience new features and updates before they're publicly released.
• 🏅 Exclusive Discord Role: Join our community with a special role that reflects your support level.
• 📢 Behind-the-Scenes Updates: Get regular insider information on current development efforts and future plans.
• 🎯 Priority Support: Receive faster responses to your questions and issues, ensuring a smooth experience.
• 👏 Public Recognition: Your name will be featured in our README and in-app credits as a valued supporter.

[!NOTE] 💖 Prefer a one-time contribution?

Click here to make a single donation and show your support!

Every patron, regardless of tier or one-time donation, plays a vital role in the app's continued improvement and sustainability.

💎 Diamond Sponsors

🏆 Platinum Sponsors

💡 Acknowledgements

• Electron-Vite: For providing an outstanding boilerplate that seamlessly integrates Electron and React, significantly accelerating our development process.
• NPM Packages: For the myriad of libraries that have been instrumental in shaping and optimizing this project.
• AI Interface: To all the brilliant AI interface developers whose work has been integral to this project.
• Iconify: For providing a wide array of beautiful open-source icons used throughout the application.

Last but not least:

• You: For using the app, providing feedback, and supporting its development. Your engagement and support are what drive this project forward.

© 2024 LynxHub.