diff --git a/CHANGELOG-zh.md b/CHANGELOG-zh.md index 9a861d80..c00c4fc1 100644 --- a/CHANGELOG-zh.md +++ b/CHANGELOG-zh.md @@ -8,6 +8,8 @@ - **启用/禁用定时任务**. 允许用户启用/禁用定时任务. [#297](https://github.com/crawlab-team/crawlab/issues/297) - **优化任务管理**. 允许用户批量删除任务. [#341](https://github.com/crawlab-team/crawlab/issues/341) - **优化爬虫管理**. 允许用户在爬虫列表页对爬虫进行筛选和排序. +- **添加中文版 `CHANGELOG`**. +- **在顶部添加 Github 加星按钮**. ### Bug 修复 - **定时任务问题**. [#423](https://github.com/crawlab-team/crawlab/issues/423) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89cd826d..6c64fbd8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ - **Enable/Disable Schedule Cron**. Allow users to enable/disable the schedule jobs. [#297](https://github.com/crawlab-team/crawlab/issues/297) - **Better Task Management**. Allow users to batch delete tasks. [#341](https://github.com/crawlab-team/crawlab/issues/341) - **Better Spider Management**. Allow users to sort and filter spiders in the spider list page. +- **Added Chinese `CHANGELOG`**. +- **Added Github Star Button at Nav Bar**. ### Bug Fixes - **Schedule Cron Task Issue**. [#423](https://github.com/crawlab-team/crawlab/issues/423) diff --git a/README-zh.md b/README-zh.md index 828209e9..7848db5d 100644 --- a/README-zh.md +++ b/README-zh.md @@ -21,7 +21,7 @@ 三种方式: 1. [Docker](https://tikazyq.github.io/crawlab-docs/Installation/Docker.html)(推荐) 2. [直接部署](https://tikazyq.github.io/crawlab-docs/Installation/Direct.html)(了解内核) -3. [Kubernetes](https://mp.weixin.qq.com/s/3Q1BQATUIEE_WXcHPqhYbA) +3. [Kubernetes](https://juejin.im/post/5e0a02d851882549884c27ad) (多节点部署) ### 要求(Docker) - Docker 18.03+ @@ -31,9 +31,17 @@ ### 要求(直接部署) - Go 1.12+ - Node 8.12+ -- Redis +- Redis 5.x+ - MongoDB 3.6+ +## 快速开始 + +```bash +git clone https://github.com/crawlab-team/crawlab +cd crawlab +docker-compose up -d +``` + ## 运行 ### Docker @@ -123,6 +131,10 @@ Docker部署的详情,请见[相关文档](https://tikazyq.github.io/crawlab-d ![](https://raw.githubusercontent.com/tikazyq/crawlab-docs/master/images/schedule.png) +#### 依赖安装 + +![](http://static-docs.crawlab.cn/node-install-dependencies.png) + ## 架构 Crawlab的架构包括了一个主节点(Master Node)和多个工作节点(Worker Node),以及负责通信和数据储存的Redis和MongoDB数据库。 diff --git a/README.md b/README.md index a02eaeaf..6677f4a2 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Golang-based distributed web crawler management platform, supporting various lan Two methods: 1. [Docker](https://tikazyq.github.io/crawlab-docs/Installation/Docker.html) (Recommended) 2. [Direct Deploy](https://tikazyq.github.io/crawlab-docs/Installation/Direct.html) (Check Internal Kernel) -3. [Kubernetes](https://mp.weixin.qq.com/s/3Q1BQATUIEE_WXcHPqhYbA) +3. [Kubernetes](https://juejin.im/post/5e0a02d851882549884c27ad) (Multi-Node Deployment) ### Pre-requisite (Docker) - Docker 18.03+ @@ -31,9 +31,17 @@ Two methods: ### Pre-requisite (Direct Deploy) - Go 1.12+ - Node 8.12+ -- Redis +- Redis 5.x+ - MongoDB 3.6+ +## Quick Start + +```bash +git clone https://github.com/crawlab-team/crawlab +cd crawlab +docker-compose up -d +``` + ## Run ### Docker @@ -121,6 +129,10 @@ For Docker Deployment details, please refer to [relevant documentation](https:// ![](https://raw.githubusercontent.com/tikazyq/crawlab-docs/master/images/schedule.png) +#### Dependency Installation + +![](http://static-docs.crawlab.cn/node-install-dependencies.png) + ## Architecture The architecture of Crawlab is consisted of the Master Node and multiple Worker Nodes, and Redis and MongoDB databases which are mainly for nodes communication and data storage. diff --git a/frontend/index.html b/frontend/index.html index 2c943e7e..5066906e 100644 --- a/frontend/index.html +++ b/frontend/index.html @@ -6,6 +6,10 @@ + + + + Crawlab diff --git a/frontend/package.json b/frontend/package.json index ffc416f1..af39a971 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -35,6 +35,7 @@ "vue-ba": "^1.2.5", "vue-codemirror": "^4.0.6", "vue-codemirror-lite": "^1.0.4", + "vue-github-button": "^1.1.2", "vue-i18n": "^8.9.0", "vue-router": "^3.0.1", "vue-virtual-scroll-list": "^1.3.9", diff --git a/frontend/public/index.html b/frontend/public/index.html index c703d044..ccf318fc 100644 --- a/frontend/public/index.html +++ b/frontend/public/index.html @@ -6,6 +6,10 @@ + + + + Crawlab diff --git a/frontend/src/i18n/zh.js b/frontend/src/i18n/zh.js index ecb0bd82..b15efd50 100644 --- a/frontend/src/i18n/zh.js +++ b/frontend/src/i18n/zh.js @@ -356,5 +356,8 @@ export default { add_cron: '生成Cron', // Cron Format: [second] [minute] [hour] [day of month] [month] [day of week] cron_format: 'Cron 格式: [秒] [分] [小时] [日] [月] [周]' - } + }, + + // 其他 + 'Star crawlab-team/crawlab on GitHub': '在 GitHub 上为 Crawlab 加星吧' } diff --git a/frontend/src/views/layout/components/Navbar.vue b/frontend/src/views/layout/components/Navbar.vue index 52960c21..882fbfa7 100644 --- a/frontend/src/views/layout/components/Navbar.vue +++ b/frontend/src/views/layout/components/Navbar.vue @@ -34,6 +34,17 @@ + + + + Star + + @@ -41,11 +52,13 @@ import { mapGetters } from 'vuex' import Breadcrumb from '@/components/Breadcrumb' import Hamburger from '@/components/Hamburger' +import GithubButton from 'vue-github-button' export default { components: { Breadcrumb, - Hamburger + Hamburger, + GithubButton }, computed: { ...mapGetters([ @@ -122,6 +135,12 @@ export default { } } + .github { + height: 50px; + margin-right: 35px; + margin-top: -10px; + } + .right { float: right } diff --git a/frontend/yarn.lock b/frontend/yarn.lock index 3e7bb8a3..b885732c 100644 --- a/frontend/yarn.lock +++ b/frontend/yarn.lock @@ -3932,6 +3932,11 @@ getpass@^0.1.1: dependencies: assert-plus "^1.0.0" +github-buttons@^2.3.0: + version "2.6.0" + resolved "https://registry.npm.taobao.org/github-buttons/download/github-buttons-2.6.0.tgz#fa3e031451cee7ba05c3254fa67c73fe783104dc" + integrity sha1-+j4DFFHO57oFwyVPpnxz/ngxBNw= + glob-base@^0.3.0: version "0.3.0" resolved "http://registry.npm.taobao.org/glob-base/download/glob-base-0.3.0.tgz#dbb164f6221b1c0b1ccf82aea328b497df0ea3c4" @@ -8587,6 +8592,13 @@ vue-eslint-parser@^5.0.0: esquery "^1.0.1" lodash "^4.17.11" +vue-github-button@^1.1.2: + version "1.1.2" + resolved "https://registry.npm.taobao.org/vue-github-button/download/vue-github-button-1.1.2.tgz#318518c3a31d0fbd278ebcc80fbc5f88d68836e6" + integrity sha1-MYUYw6MdD70njrzID7xfiNaINuY= + dependencies: + github-buttons "^2.3.0" + vue-hot-reload-api@^2.3.0: version "2.3.2" resolved "http://registry.npm.taobao.org/vue-hot-reload-api/download/vue-hot-reload-api-2.3.2.tgz#1fcc1495effe08a790909b46bf7b5c4cfeb6f21b"