Yacd-meta/README.md
2023-04-27 22:54:48 +08:00

1.6 KiB

yacd

Yet Another Clash Dashboard

Usage

Install twemoji 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, 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

# 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