Tunasync Panel

A web-based control panel for managing tunasync.

中文文档

📸 Preview

✨ Features

• A modern web interface to interact with tunasync.
• A separate backend API built with Koa.js.
• Monorepo structure for easy development and dependency management.

🧩 Modules

• Display mirror site status ✅
• Modify mirror site configuration ✅
• Website i18n ✅
• Testing Rsync mirror ✅
• Testing Git mirror ⏳
• Testing other command mirror ⏳
• Fine-grained control of individual mirrors ⏳
• Docker Support ❌

🛠️ Tech Stack

• Frontend:
  • Preact
  • Vite
• Backend:
  • Koa.js

🚀 Getting Started

Prerequisites

• Node.js (LTS version recommended)
• npm

Installation

1. Clone the repository:

   git clone https://github.com/EzioSweet/tunasync-panel.git
   cd tunasync-panel

2. Install dependencies for all packages from the root directory:

   npm install

Running the Application

To start both the frontend development server and the backend server concurrently, run the following command from the root directory:

npm start

This will:

• Start the frontend on http://localhost:5173 (or another port if 5173 is in use).
• Start the backend server.

📂 Project Structure

The project is a monorepo using npm workspaces:

. 
├── packages/
│   ├── backend/      # Koa.js backend
│   └── frontend/     # Preact frontend
├── package.json      # Root package.json
└── readme.md

📄 License

This project is licensed under the BSD-3-Clause License. See the package.json file for details.