Node-Sneaker

一个基于 Koa2, Typescript 构建的球鞋比价网 API service, 整合Dewu, Goat, StockX的鞋子价格数据并提供接口

API

API 文档

技术桟

• Koa2
• Typescript
• Axios
• Gulp
• MongoDB

Usage

1、安装

$ git clone https://github.com/Jasonzj/node-sneaker.git
$ cd node-sneaker 
$ yarn

2、配置环境变量

环境变量

3、方法1: 直接运行

$ yarn start

4、方法2: Docker容器运行

先创建~/data/db 用于存放mongodb数据库文件, 用于持久化数据(使用Bind Mounts方式)

再创建一个目录node-sneaker用于存放docker-compose配置和隐私环境变量

node-sneaker
├── variables.env
└── docker-compose.yml

启动

$ cd node-sneaker
$ docker-compose up -d #修改docker-compose.yml后需要使用此命令使更改生效

环境变量

项目环境变量配置文件位于server/config/env

• 在开发环境中 (NODE_ENV=development)：自动从文件 configs/env/development.ts 读取配置。

• 在生产环境中 (NODE_ENV=production): 自动从文件 configs/env/production.ts 读取配置。

• 任何环境: 如果 process.env 存在同名常量，会覆盖上述 2 个环境配置文件。优先级第二高

• 任何环境: 如果 variables.env 文件内存在同名常量，会覆盖上述 2 个环境配置文件和process.env。优先级最高。

环境变量说明

变量名	说明
PORT	端口号
API_PREFIX	API前缀
SEARCH_LIMIT	搜索数量限制
CONCURRENT_LIMIT	爬虫并发限制
DEWU_LIMIT	DEWU搜索接口数量限制
DEWU_CONCURRENT_LIMIT	DEWU搜索接口并发限制
REQUIRE_TIMEOUT	请求超时时间/秒
PROXY_HOST	代理地址
PROXY_PORT	代理端口，设置PROXY_HOST & PROXY_PROT后开启代理

代理适用于Goat, StockX

隐私环境变量说明

变量名	说明
MONGODB_LINK	mongodb连接地址, 使用docker-compose方式的话连接地址为service name(指定service name会自动创建network alias)
JWT_SECRET	jwt加密
SALT_WORK_FACTOR	密码加盐系数

新建variables.env, 该文件用来存放隐私环境变量

variables.env demo

MONGODB_LINK=mongodb://localhost:XX  #使用docker-compose方式: mongodb://database(这里填service name):XX
JWT_SECRET=jwtsecret
SALT_WORK_FACTOR=9

前端地址

GitHub | 在线地址