https://github.com/MetaCubeX/Yacd-meta

Yet Another Clash Dashboard
https://github.com/MetaCubeX/Yacd-meta

Last synced: 4 months ago
JSON representation

Yet Another Clash Dashboard

• Host: GitHub
• URL: https://github.com/MetaCubeX/Yacd-meta
• Owner: MetaCubeX
• Fork: true (haishanh/yacd)
• Created: 2022-05-25T14:18:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T06:18:10.000Z (6 months ago)
• Last Synced: 2024-08-11T07:27:41.038Z (6 months ago)
• Language: TypeScript
• Homepage: http://yacd.metacubex.one
• Size: 5.17 MB
• Stars: 453
• Watchers: 6
• Forks: 148
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
[中文](./README_CN.md)



  



> Yet Another [Clash](https://github.com/yaling888/clash) [Dashboard](https://github.com/yaling888/clash-dashboard)

## Usage

Install [twemoji](https://github.com/mozilla/twemoji-colr/releases) to display emoji better on Windows system.

The site http://yacd.metacubex.one is served with HTTP not HTTPS is because many browsers block requests to HTTP resources from a HTTPS website. If you think it's not safe, you could just download the [zip of the gh-pages](https://github.com/MetaCubeX/yacd/archive/gh-pages.zip), unzip and serve those static files with a web server(like Nginx).

**Supported URL query params**

| Param    | Description                                                                        |

| -------- | ---------------------------------------------------------------------------------- |

| hostname | Hostname of the clash backend API (usually the host part of `external-controller`) |

| port     | Port of the clash backend API (usually the port part of `external-controller`)     |

| secret   | Clash API secret (`secret` in your config.yaml)                                    |

| theme    | UI color scheme (dark, light, auto)                                                |

## Development

```sh

# install dependencies

# you may install pnpm with `npm i -g pnpm`

pnpm i

# start the dev server

# then go to http://127.0.0.1:3000

pnpm start

# build optimized assets

# ready to deploy assets will be in the directory `public`

pnpm build

```