mirror of https://github.com/IoTcat/coro-api.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
73 lines
1.2 KiB
73 lines
1.2 KiB
# coro-api |
|
新型冠状病毒 api |
|
|
|
## 快速开始 |
|
|
|
### 环境要求 |
|
- `nodeJS`支持`express`任意版本 |
|
- `git`任意版本 |
|
|
|
### 下载文件 |
|
``` |
|
$ git clone https://github.com/iotcat/coro-api.git & cd coro-api |
|
``` |
|
|
|
### 安装依赖 |
|
```shell |
|
$ npm install |
|
``` |
|
|
|
### 启动 |
|
```shell |
|
$ node index.js |
|
``` |
|
|
|
## 访问 |
|
``` |
|
http://localhost:17676 |
|
``` |
|
|
|
## GET参数 |
|
参数 | 描述 | 示例 |
|
:--: | :--: | :--: |
|
province | 省份(国家) | 山东 |
|
city | 城市 | 泰安 |
|
|
|
``` |
|
http://localhost:17676/?province=山东 |
|
``` |
|
``` |
|
http://localhost:17676/?city=泰安 |
|
``` |
|
|
|
## 进阶 |
|
|
|
### 修改端口 |
|
|
|
从`index.js`第9行修改默认端口。 |
|
|
|
### 使用pm2守护进程 |
|
|
|
```shell |
|
$ npm i -g pm2 |
|
$ pm2 start index.js --name coro-api -o /var/log/coro/api.out -e /var/log/coro/api.err --watch |
|
``` |
|
|
|
### Nginx配置 |
|
|
|
将以下内容加入`server{}`中 |
|
```nginx |
|
location / { |
|
proxy_pass http://127.0.0.1:17676; |
|
} |
|
|
|
``` |
|
如果你不是从根目录映射,记得去`index.js`中第11行`app.get('/', f)`修改成你的路径。 |
|
|
|
### 爬虫配置 |
|
|
|
爬虫使用[coro-py](https://github.com/iotcat/coro-py), 请参考其文档。 |
|
|
|
## 开源协议 |
|
|
|
本项目使用MIT协议,允许非署名商业非商业使用。武汉加油!中国加油!!❤ |