busya/ss-tools

Files

busya 2d8cae563f feat: implement plugin architecture and application settings with Svelte UI

- Added plugin base and loader for backend extensibility
- Implemented application settings management with config persistence
- Created Svelte-based frontend with Dashboard and Settings pages
- Added API routes for plugins, tasks, and settings
- Updated documentation and specifications
- Improved project structure and developer tools

2025-12-20 20:48:18 +03:00

1.0 KiB

Executable File

Raw Permalink Blame History

Quickstart: Plugin Architecture & Svelte Web UI

Prerequisites

Python 3.9+
Node.js 18+
npm or pnpm

Setup

Install Backend Dependencies:

cd backend
python -m venv venv
source venv/bin/activate  # or venv\Scripts\activate on Windows
pip install -r requirements.txt

Install Frontend Dependencies:
```
cd frontend
npm install
```

Running the Application

Start Backend Server:

# From backend/ directory
uvicorn src.app:app --reload --port 8000

Start Frontend Dev Server:
```
# From frontend/ directory
npm run dev
```
Access the UI: Open http://localhost:5173 in your browser.

Adding a Plugin

Create a new Python file in backend/src/plugins/ (e.g., my_plugin.py).
Define your plugin class inheriting from PluginBase.
Implement execute and get_schema methods.
Restart the backend (or rely on auto-reload).
Your plugin should appear in the Web UI.