从零开始使用streetmerchant项目指南-优快云博客

从零开始使用streetmerchant项目指南

streetmerchant 🤖 The world's easiest, most powerful stock checker 项目地址: https://gitcode.com/gh_mirrors/st/streetmerchant

项目简介

streetmerchant是一个智能化的库存监控工具，主要用于追踪热门商品（如显卡、游戏主机等）的库存状态。当目标商品有货时，它能通过多种方式及时通知用户。该项目支持多种运行方式，适合不同技术水平的用户。

环境准备

在开始使用前，您需要准备以下基础环境：

版本控制工具：用于获取项目代码
运行环境（二选一）：
- Node.js 16（长期支持版本）
- Docker（适合高级用户）

Node.js运行方式

版本选择建议

| 版本类型 | 说明 | |:---:|---| | 标签版本（如v1.0.0） | 稳定版本，推荐生产环境使用 | | main分支 | 最新开发版本，可能不稳定 |

详细步骤

安装Node.js 16：从官网获取适合您操作系统的安装包
获取项目代码：使用版本控制工具克隆项目仓库
切换目录：进入项目文件夹
安装依赖：执行npm install命令
配置环境：
- 复制dotenv-example文件并重命名为dotenv
- 使用文本编辑器（如VSCode）根据需求修改配置
启动程序：运行npm run start

操作提示

停止程序：使用Ctrl+C组合键
开发模式：使用npm run start:dev可启用文件变更自动重启功能
代码检查：npm run lint检查代码风格，npm run fix自动修复可修复的问题

Docker运行方式

镜像版本说明

| 标签 | 说明 | |:---:|---| | latest | 最新稳定版本 | | nightly | 每日构建版本，可能不稳定 |

基本命令

# 运行nightly版本
docker run -it --rm \
  --env-file ./dotenv \
  镜像仓库地址:nightly

# 测试通知功能
docker run -it --rm  \
  --env-file ./dotenv \
  镜像仓库地址:nightly test:notification:production

配置自定义

复制dotenv-example为dotenv
根据需求修改配置项
所有环境变量均为可选，可根据实际情况配置

高级开发指南

Docker开发环境

前置条件

Docker 1.13.0+
GNU Make（可选但推荐）
Docker Compose（部分系统已预装）

使用docker-compose

准备.env配置文件
使用Make命令：
- make run启动
- make stop停止

或直接使用docker-compose命令：

# 启动
docker-compose up

# 停止
docker-compose down

特殊配置

如果使用WEB_PORT，需要在docker-compose中添加端口映射配置。

Heroku部署

准备工作

安装Heroku CLI并登录
确保Git可用
修改项目文件：
- 调整dotenv配置
- 修改.gitignore
- 更新package.json
- 创建Procfile
- 修改src/index.ts

Heroku设置

创建新应用
添加构建包：
- heroku/nodejs
- puppeteer-heroku-buildpack

部署流程

初始化Git仓库
添加Heroku远程
提交代码
推送至Heroku

最终配置

在Heroku控制台调整资源：
- 关闭web npm start
- 启用worker npm run start:production
通过日志监控运行状态

实用建议

首次使用建议从稳定版本开始
配置通知功能以确保不错过库存更新
生产环境推荐使用Docker方式运行
开发时可利用热重载功能提高效率

通过以上步骤，您应该能够顺利配置并运行streetmerchant项目，开始监控您感兴趣的商品库存状态。

streetmerchant 🤖 The world's easiest, most powerful stock checker 项目地址: https://gitcode.com/gh_mirrors/st/streetmerchant

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考