yacd/README.md

<h1 align="center">
  <img src="https://user-images.githubusercontent.com/1166872/47954055-97e6cb80-dfc0-11e8-991f-230fd40481e5.png" alt="yacd">
</h1>

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

The site [http://yacd.haishan.me](http://yacd.haishan.me) is served with HTTP not HTTPS is because many browsers blocking request to HTTP resources from a HTTPS website. If you think it's not safe or has security concern, you can actually download the [zip of the gh-pages](https://github.com/haishanh/yacd/archive/gh-pages.zip), unzip and open `index.html` directly.

[Docker image](https://hub.docker.com/r/haishanh/yacd) is also available as `haishanh/yacd`.

Extra note for Firefox users:

**yacd** is using the [Fetch (Web) API][fetch-api] to stream chunked API response from Clash to draw the traffic chart. But currently the streaming feature in Firefox needs to be turned on manually. Here is how to:

Visit `about:config`, search for `dom.streams.enabled` and `javascript.options.streams`, double click those items to turn them on.

[fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

## Development

```sh
# install dependencies
yarn

# start the dev server
yarn start

# go to http://127.0.0.1:3000
```
doc: add a screenshot to the readme 2018-11-03 23:32:04 +08:00			`<h1 align="center">`
			`<img src="https://user-images.githubusercontent.com/1166872/47954055-97e6cb80-dfc0-11e8-991f-230fd40481e5.png" alt="yacd">`
			`</h1>`
doc: add simple readme 2018-10-20 20:34:35 +08:00
doc(readme): add clash-dashboard repo url 2019-01-02 23:07:12 +08:00			`> Yet Another [Clash](https://github.com/Dreamacro/clash) [Dashboard](https://github.com/Dreamacro/clash-dashboard)`
doc: add note for how to turn on fetch streaming in firfox 2018-10-21 16:01:50 +08:00
Update README.md (#302) Improve English sentence more readability Change from `not comfort with this` --to--> `has security concern` 2019-11-12 12:45:27 +08:00			The site [http://yacd.haishan.me](http://yacd.haishan.me) is served with HTTP not HTTPS is because many browsers blocking request to HTTP resources from a HTTPS website. If you think it's not safe or has security concern, you can actually download the [zip of the gh-pages](https://github.com/haishanh/yacd/archive/gh-pages.zip), unzip and open `index.html` directly.
doc: update readme about http served site 2018-10-21 21:27:08 +08:00
docs: update README docker image link 2019-11-14 00:35:27 +08:00			[Docker image](https://hub.docker.com/r/haishanh/yacd) is also available as `haishanh/yacd`.
docs: mention docker image in README 2019-11-09 15:06:08 +08:00
doc: update readme about http served site 2018-10-21 21:27:08 +08:00			`Extra note for Firefox users:`
doc: add note for how to turn on fetch streaming in firfox 2018-10-21 16:01:50 +08:00
			`yacd is using the [Fetch (Web) API][fetch-api] to stream chunked API response from Clash to draw the traffic chart. But currently the streaming feature in Firefox needs to be turned on manually. Here is how to:`

doc: add development section into readme 2018-10-21 18:25:50 +08:00			Visit `about:config`, search for `dom.streams.enabled` and `javascript.options.streams`, double click those items to turn them on.
doc: add note for how to turn on fetch streaming in firfox 2018-10-21 16:01:50 +08:00
			`[fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API`
doc: add development section into readme 2018-10-21 18:25:50 +08:00
			`## Development`

			```sh
			`# install dependencies`
			`yarn`

			`# start the dev server`
			`yarn start`

			`# go to http://127.0.0.1:3000`
			```