chinese-colors/README.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

2019-09-18 14:57:47 +08:00
# <img src="demo/logo.png" alt="Logo" width="50"> Chinese Color
2019-09-18 15:12:14 +08:00
> [中文文档](README.zh.md)
2019-09-10 14:24:20 +08:00
[Chinese Color Cheatsheet](https://works.yangerxiao.com/chinese-colors/)
2019-09-10 14:59:31 +08:00
<img src="demo/pc.png" alt="PC UI" width="600">
2019-09-18 14:57:47 +08:00
## Features
2019-09-10 18:19:36 +08:00
2019-09-18 14:57:47 +08:00
- Build with react.js
- PWA supported
2019-09-18 15:12:14 +08:00
<img src="demo/pwa.jpg" alt="PWA Logo" width="300">
2019-09-10 14:59:31 +08:00
2019-09-18 14:57:47 +08:00
- Responsive (Mobile First)
2019-09-18 15:12:14 +08:00
<img src="demo/m.png" alt="Mobile UI" width="300">
2019-09-10 18:19:36 +08:00
2019-09-18 14:57:47 +08:00
- Highlight the selected color
- Classify the colors
- Copy HEX
- Add to favorites
2019-09-18 15:12:14 +08:00
- Wallpaper (not stable, welcome [feedback](https://github.com/zerosoul/chinese-colors/issues)).
<img src="demo/screenshot.png" alt="screen shot" width="300">
## Technology Stack & Thanks
- [create-react-app](https://github.com/facebook/create-react-app)
- [react.js](https://reactjs.org)
- [styled-components](https://styled-components.com): CSS-IN-JS Best Practice
- eslint + prettier: for better code
- husky + commitlint: for better git commit format
- [html2canvas](http://html2canvas.hertzen.com/)
- [pinyin](https://github.com/hotoo/pinyin): convert Han to pinyin
- [react-copy-to-clipboard](https://github.com/nkbt/react-copy-to-clipboard): enable copy
2019-09-18 16:58:35 +08:00
- [iconfont.cn](https://iconfont.cn): icons
- [https://www.transparenttextures.com/](https://www.transparenttextures.com/): awesome pattern images
2019-09-18 15:12:14 +08:00
- Thanks the great Open Source
2019-09-18 17:02:04 +08:00
## Local Development
`git clone https://github.com/zerosoul/chinese-colors.git`
`cd chinese-colors && npm install`
`npm run start`
enjoy: `http://localhost:8099/`
2019-09-18 14:57:47 +08:00
## Changelog
2019-09-10 14:24:20 +08:00
2019-09-18 14:57:47 +08:00
[Changelog](CHANGELOG.md)
2019-09-10 14:24:20 +08:00
2019-09-18 14:57:47 +08:00
## Reference
2019-09-10 14:24:20 +08:00
2019-09-18 14:57:47 +08:00
- Color data source[中国传统颜色](http://blog.sina.com.cn/s/blog_5c3b139d0101deia.html)
- UI[nipponcolors.com](http://nipponcolors.com/)