mirror of
https://github.com/opelly27/streetmerchant.git
synced 2026-05-20 02:57:34 +00:00
feat(docs): add mkdocs
This commit is contained in:
Jef LeCompte
@@ -0,0 +1,11 @@
|
||||
# About
|
||||
|
||||
## Background
|
||||
|
||||
Remember on September 17th, 2020 at 9 AM EST the Nvidia site went from **Notify Me** to **Out of Stock** instantly? Well, they didn't sell any cards. The real reason was that they weren't ready to sell them to us yet. That's right, they turned off their third party storefronts because they were being overloaded with our clicks. They still kept the other cards that use those APIs online, but they removed that one. It was re-enabled at some point for a brief moment, but the same thing happened -- servers overloaded with API requests.
|
||||
|
||||
This is where streetmerchant comes in. It doesn't buy anything for you, but it makes it more of a stress free job to refresh and check sites while you go about your daily business. People took off work, missed appointments, and gave up other lively needs in hopes to buy a _graphics card_. Now we reach beyond graphics cards in hopes for other products!
|
||||
|
||||
Please enjoy,
|
||||
|
||||
jef
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 358 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 865 KiB |
Symlink
+1
@@ -0,0 +1 @@
|
||||
../CHANGELOG.md
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
# FAQ
|
||||
|
||||
## What's Node.js and how do I install it?
|
||||
|
||||
Visit [their website](https://nodejs.org/en/) and download and install it. Very straight forward. Otherwise, Google more information related to your system needs.
|
||||
|
||||
## Will this harm my computer?
|
||||
|
||||
No.
|
||||
|
||||
## Have you gotten a card yet?
|
||||
|
||||
[Sure did!](https://i.imgur.com/59CRzGq.png)
|
||||
|
||||
## Will I get banned from of the stores?
|
||||
|
||||
Perhaps, but it's the risk we're willing to take! To help minimize this, take a look at [#1050](https://github.com/jef/streetmerchant/issues/1050).
|
||||
|
||||
## I got a problem and need help
|
||||
|
||||
File an [issue](https://github.com/jef/streetmerchant/issues/new/choose). I'll do my best to get to you. I work a full time job and this is only a hobby of mine.
|
||||
|
||||
## How do I get the latest code?
|
||||
|
||||
Run the following commands:
|
||||
|
||||
```shell
|
||||
git pull origin main
|
||||
npm install
|
||||
npm run start
|
||||
```
|
||||
|
||||
If you changed the code at all, this will most likely fail. You can clear out your changes by doing:
|
||||
|
||||
```shell
|
||||
git checkout .
|
||||
git pull origin main
|
||||
npm install
|
||||
npm run start
|
||||
```
|
||||
|
||||
You can also to [git-stash](https://git-scm.com/docs/git-stash), but we won't expand on that here.
|
||||
|
||||
|
||||
## Why don't my notifications work?
|
||||
|
||||
There is probably an [issue](https://github.com/jef/streetmerchant/issues?q=is%3Aissue+sort%3Aupdated-desc+sound+is%3Aclosed) that has [already](https://github.com/jef/streetmerchant/issues/182) [been](https://github.com/jef/streetmerchant/issues/116) [resolved](https://github.com/jef/streetmerchant/issues/155).
|
||||
|
||||
## I'd love to contribute, how do I do that?
|
||||
|
||||
Make a [pull request](https://github.com/jef/streetmerchant/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)! All contributions are welcome.
|
||||
|
||||
## How do I add a store?
|
||||
|
||||
Take a look at [this page](https://github.com/jef/streetmerchant/wiki/Help:-Configuration:-Adding-a-store) on the wiki.
|
||||
|
||||
## Why do I have to download all this stuff just to get this bot working?
|
||||
|
||||
Well, I would rather you didn't either. See [#11](https://github.com/jef/streetmerchant/issues/11).
|
||||
|
||||
## Why does Amazon show an error page (with a picture of an animal) instead of adding to cart or going to the detail page?
|
||||
|
||||
This is intended; see [#733](https://github.com/jef/streetmerchant/issues/733). This indicates that the item is out of stock and only available from a third-party seller (often at a markup).
|
||||
|
||||
## I'm using streetmerchant in the cloud and X isn't working.
|
||||
|
||||
There is _a lot_ of undefined behavior with using streetmerchant in the cloud. Some sites may block IPs from your cloud provider. It is possible that a VPN will help circumvent these problems.
|
||||
@@ -0,0 +1,61 @@
|
||||
# Getting started
|
||||
|
||||
You do not need any computer skills, smarts, or anything of that nature. You are very capable as you have made it this far. Some basic understanding how a terminal, git, and or Node.js is a bonus, but that does not limit you to getting streetmerchant running!
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [git](https://git-scm.com/)
|
||||
- Either [Node.js 14](https://nodejs.org/en/) or [Docker](https://docs.docker.com/get-docker/) (advanced users)
|
||||
|
||||
## Using Node.js
|
||||
|
||||
| Reference | Note |
|
||||
|:---:|---|
|
||||
| tag | Example, `v1.0.0`; stable |
|
||||
| `main` | Latest HEAD; not tagged, could be unstable |
|
||||
|
||||
- [Node.js 14](https://nodejs.org/en/)
|
||||
- Clone this project `git clone https://github.com/jef/streetmerchant.git`.
|
||||
- To checkout a particular reference, use `git checkout <ref name>` after cloning.
|
||||
- Navigate to this project by entering `cd streetmerchant`.
|
||||
- Run `npm install`.
|
||||
- Make a copy of `.env-example` and name it `.env`.
|
||||
- Edit the `.env` file to your liking using a text editor (like [vscode](https://code.visualstudio.com/)).
|
||||
- Run `npm run start` to start.
|
||||
|
||||
At any point you want the program to stop, use ++ctrl+c++.
|
||||
|
||||
???+ tip
|
||||
Community based help can also be found on the [wiki](https://github.com/jef/streetmerchant/wiki). Feel free to check that out if you're having problems running. If you're still having problems running, you're probably not the first. Make some searches through the [GitHub issues](https://github.com/jef/streetmerchant/issues) before making one.
|
||||
|
||||
## Using Docker
|
||||
|
||||
Available via GitHub Container Registry.
|
||||
|
||||
| Tag | Note |
|
||||
|:---:|---|
|
||||
| `latest` | Latest release; stable |
|
||||
| `nightly` | Latest HEAD each day at midnight UTC; could be unstable |
|
||||
|
||||
```sh
|
||||
# to run docker nightly
|
||||
docker run --cap-add=SYS_ADMIN \
|
||||
-it --rm --env-file ./.env \
|
||||
ghcr.io/jef/streetmerchant:nightly
|
||||
|
||||
# to test notifications
|
||||
docker run --cap-add=SYS_ADMIN \
|
||||
-it --rm --env-file ./.env \
|
||||
ghcr.io/jef/streetmerchant:nightly test:notification:production
|
||||
```
|
||||
|
||||
## Customization
|
||||
|
||||
To customize streetmerchant, make a copy of `.env-example` as `.env` and make any changes to your liking. View [Reference](docs/reference/application.md) for more information on variables and their usage.
|
||||
|
||||
???+ tip
|
||||
All environment variables are optional.
|
||||
|
||||
## For developers
|
||||
|
||||
The command `npm run start:dev` can be used instead of `npm run start` to automatically restart the project when filesystem changes are detected in the `src/` folder or `.env` file.
|
||||
@@ -0,0 +1,111 @@
|
||||
# General
|
||||
|
||||
## Adding a store
|
||||
|
||||
???+ note
|
||||
This is subject to change in the future
|
||||
|
||||
In the following examples, I will be using "NewStore" as the store I'm wanting to add.
|
||||
|
||||
### Creating a store file
|
||||
|
||||
First, create a TypeScript file in `src/store/model`. In this example, I'll create a file named `new-store.ts`. At this point, you can copy and paste any of the other stores and change accordingly.
|
||||
|
||||
#### How to grab a container (aka selector)
|
||||
|
||||
For the containers, what you'll wanna do is use <kbd>F12</kbd> on the site you want to Inspect and click this button
|
||||
|
||||
|
||||
|
||||
Hover over the item you want and it should give you the context:
|
||||
|
||||
|
||||
|
||||
You can also right-click on any website element and select 'Inspect'. That should also give you the same results.
|
||||
|
||||
Some people will decide to choose a parent element as it can be unique. Like this case!
|
||||
|
||||
I'd rather use `.button.spin-button.prod-ProductCTA--primary.button--primary` instead of `.spin-button-children` as there are probably other elements on the page that are also `.spin-button-children`.
|
||||
|
||||
The reason why we use these selectors anyway is to wait for the webpage to load these specific elements, to help eliminate false positives.
|
||||
|
||||
For easily getting the selector, you can also copy it by right clicking on the tag, Copy > Copy selector.
|
||||
|
||||
|
||||
|
||||
### Updating the models
|
||||
|
||||
You'll now want to add the new store to `src/store/model/index.ts`.
|
||||
|
||||
This is what it will look like:
|
||||
|
||||
```diff
|
||||
--- a/src/store/model/index.ts
|
||||
+++ b/src/store/model/index.ts
|
||||
@@ -48,6 +48,7 @@ import {MicroCenter} from './microcenter';
|
||||
import {Mindfactory} from './mindfactory';
|
||||
import {Newegg} from './newegg';
|
||||
import {NeweggCa} from './newegg-ca';
|
||||
+import {NewStore} from './new-store';
|
||||
import {Notebooksbilliger} from './notebooksbilliger';
|
||||
import {Novatech} from './novatech';
|
||||
import {Nvidia} from './nvidia';
|
||||
@@ -123,6 +124,7 @@ export const storeList = new Map([
|
||||
[Mindfactory.name, Mindfactory],
|
||||
[Newegg.name, Newegg],
|
||||
[NeweggCa.name, NeweggCa],
|
||||
+ [NewStore.name, NewStore],
|
||||
[Notebooksbilliger.name, Notebooksbilliger],
|
||||
[Novatech.name, Novatech],
|
||||
[Nvidia.name, Nvidia],
|
||||
```
|
||||
|
||||
After that, you're pretty much set. If you plan on adding new models or series, you will have to add them to `src/store/model/store.ts`.
|
||||
|
||||
Here's an example:
|
||||
|
||||
```diff
|
||||
--- a/src/store/model/store.ts
|
||||
+++ b/src/store/model/store.ts
|
||||
@@ -23,6 +23,7 @@ export type Brand =
|
||||
| 'kfa2'
|
||||
| 'microsoft'
|
||||
| 'msi'
|
||||
+ | 'new brand'
|
||||
| 'nvidia'
|
||||
| 'palit'
|
||||
| 'pny'
|
||||
@@ -37,6 +38,7 @@ export type Series =
|
||||
| '3070'
|
||||
| '3080'
|
||||
| '3090'
|
||||
+ | 'new series'
|
||||
| 'rx6800'
|
||||
| 'rx6800xt'
|
||||
| 'rx6900xt'
|
||||
@@ -83,6 +85,7 @@ export type Model =
|
||||
| 'ichill x2'
|
||||
| 'ichill x3'
|
||||
| 'ichill x4'
|
||||
+ | 'new model'
|
||||
| 'nitro+'
|
||||
| 'nitro oc se'
|
||||
| 'nitro oc'
|
||||
```
|
||||
|
||||
And voila! You're done! If you'd like to contribute to the project, feel free to create a [Pull Request](https://github.com/jef/streetmerchant/compare)! Don't forget to add the store (and brand, model, and series if you added) to the `README.md`.
|
||||
|
||||
???+ tip
|
||||
Here's an [example](https://github.com/jef/streetmerchant/commit/af96c5f2e808af7496f3c3299e4cf173105de48b).
|
||||
|
||||
## Creating a Discord webhook
|
||||
|
||||
Take a look at Discord's [Intro to Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks), that should get you going.
|
||||
|
||||
This is the main portion:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Use the full URL that you just copied and set that value to `DISOCRD_WEB_HOOK`.
|
||||
@@ -0,0 +1,50 @@
|
||||
# Troubleshoot
|
||||
|
||||
## Captcha issues
|
||||
|
||||
### Option 1
|
||||
|
||||
If you're running into _a lot_ of captcha problems, be sure to update your user agent by searching ["what's my user agent" on Google](https://www.google.com/search?q=whats+my+user+agent).
|
||||
|
||||
|
||||
|
||||
You can update your user agent by using `USER_AGENT="your-result"`.
|
||||
|
||||
### Option 2
|
||||
|
||||
If you're _still_ running into problems, try running in headful mode: `HEADLESS="false"`.
|
||||
|
||||
This will open a browser and run streetmerchant. Note that this isn't a great solution for those running in a headless environment, i.e.: VPS, cloud, docker. Instead, it would be a good solution for those running on separate computer that won't be blocked by running in the background.
|
||||
|
||||
### Option 3
|
||||
|
||||
As a last case scenario, use `PUPPETEER_EXECUTABLE_PATH`. This will use your computer's Chrome browser. You can run this is headless or headful mode.
|
||||
|
||||
> From the puppeteer doc:
|
||||
>
|
||||
> `PUPPETEER_EXECUTABLE_PATH` - specify an executable path to be used in `puppeteer.launch`. See [puppeteer.launch([options])](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#puppeteerlaunchoptions) on how the executable path is inferred. **BEWARE**: Puppeteer is only [guaranteed to work](https://github.com/puppeteer/puppeteer/#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy) with the bundled Chromium, use at your own risk.
|
||||
|
||||
For example:
|
||||
|
||||
`.env`:
|
||||
|
||||
```
|
||||
PUPPETEER_EXECUTABLE_PATH=/usr/bin/google-chrome-stable
|
||||
```
|
||||
|
||||
This will vary depending on your operating system and install path. Please use full paths.
|
||||
|
||||
## macOS code signing
|
||||
|
||||
If you're getting a popup like this:
|
||||
|
||||
|
||||
|
||||
Then run this command:
|
||||
|
||||
```sh
|
||||
sudo codesign --force --deep --sign - ./node_modules/puppeteer/.local-chromium/mac-800071/chrome-mac/Chromium.app
|
||||
```
|
||||
|
||||
???+ tip
|
||||
The `mac-800071` may be different on your machine, so I would start from `./node_modules/puppeteer/.local-chromium` and auto complete from there.
|
||||
@@ -0,0 +1,37 @@
|
||||
[](https://jef.codes/streetmerchant)
|
||||
|
||||
## Features
|
||||
|
||||
First and foremost, this service _will not_ automatically buy for you.
|
||||
|
||||
- **Checks stock continuously** -- runs 24/7, 365, looking for the items you want.
|
||||
- **Ready for checkout** -- ability to add to cart when available and even opens the browser for you.
|
||||
- **Notifications galore** -- when you're not by your computer, worry free with notifications to most platforms and devices when an item comes in stock.
|
||||
|
||||
## Getting started
|
||||
|
||||
You'll find most of the content on the left sidebar. The right sidebar will help you navigate a page.
|
||||
|
||||
### Contributing
|
||||
|
||||
- Give helpful tips and tricks to the [community based wiki](https://github.com/jef/streetmerchant/wiki).
|
||||
- Add to the documentation through [pull requests](https://github.com/jef/streetmerchant/pulls).
|
||||
- Fork and make a pull request to the repository.
|
||||
|
||||
### Looking for help
|
||||
|
||||
- File a [GitHub issue](https://github.com/jef/streetmerchant/issues/new/choose).
|
||||
- Join us on [Discord](https://discord.gg/gbVY4vB9JF).
|
||||
|
||||
### Supporting the project
|
||||
|
||||
The best way to support me is to donate to [Diabetes Research Institute](https://www.diabetesresearch.org/Give).
|
||||
|
||||
> The Diabetes Research Institute leads the world in cure-focused diabetes research.
|
||||
>
|
||||
> [diabetesresearch.org](https://www.diabetesresearch.org/about-DRI)
|
||||
|
||||
If you feel inclined to support me directly, here are those options:
|
||||
|
||||
- [GitHub Sponsors](https://github.com/sponsors/jef)
|
||||
- [Paypal](https://www.paypal.me/jxf)
|
||||
@@ -0,0 +1,29 @@
|
||||
# Application
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `AUTO_ADD_TO_CART` | Enable auto add to cart on support stores, default: `true` |
|
||||
| `BROWSER_TRUSTED` | Skip Chromium Sandbox. Useful for containerized environments, default: `false` |
|
||||
| `HEADLESS` | Puppeteer to run headless or not. Debugging related, default: `true` |
|
||||
| `INCOGNITO` | Puppeteer to run incognito or not. Debugging related, default: `false` |
|
||||
| `IN_STOCK_WAIT_TIME` | Time to wait between requests to the same link if it has that card in stock. In seconds, default: `0` |
|
||||
| `LOG_LEVEL` | [Logging levels](https://github.com/winstonjs/winston#logging-levels). Debugging related, default: `info` |
|
||||
| `LOW_BANDWIDTH` | Blocks images/fonts to reduce traffic. Disables ad blocker, default: `false` |
|
||||
| `OPEN_BROWSER` | Toggle for whether or not the browser should open when item is found. Default: `true` |
|
||||
| `PAGE_BACKOFF_MIN` | Minimum backoff time between retrying requests for the same store when a forbidden response is received. Default: `10000` |
|
||||
| `PAGE_BACKOFF_MAX` | Maximum backoff time between retrying requests for the same store when a forbidden response is received. Default: `3600000` |
|
||||
| `PAGE_SLEEP_MIN` | Minimum sleep time between queries of the same product page. In milliseconds, default: `5000` |
|
||||
| `PAGE_SLEEP_MAX` | Maximum sleep time between queries of the same product page. In milliseconds, default: `10000` |
|
||||
| `PAGE_TIMEOUT` | Navigation Timeout in milliseconds. `0` for infinite, default: `30000` |
|
||||
| `PROXY_PROTOCOL` | protocol of proxy server, such as `socks5`. Default: `http` |
|
||||
| `PROXY_ADDRESS` | IP Address or fqdn of proxy server |
|
||||
| `PROXY_PORT` | TCP Port number on which the proxy is listening for connections. Default: `80` |
|
||||
| `SCREENSHOT` | Capture screenshot of page if a card is found. Default: `true` |
|
||||
| `USER_AGENT` | Custom User-Agents headers for HTTP requests. Newline separated, e.g.: `USER_AGENT_STRING1 \n USER_AGENT_STRING2`. Default: `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36` |
|
||||
| `WEB_PORT` | Starts a webserver to be able to control the bot while it is running. Setting this value starts this service. Default: `` |
|
||||
|
||||
???+ note
|
||||
You can find your computer's user agent by [searching google for "my user agent"](http://google.com/search?q=my+user+agent)
|
||||
|
||||
???+ tip
|
||||
Data usage is [known to be high](https://github.com/jef/streetmerchant/issues?q=is%3Aissue+sort%3Aupdated-desc+bandwidth). This is expected as the program scrapes many websites in parallel 24/7. To help reduce this, use `LOW_BANDWIDTH="true"`. We are looking into other solutions as well, but is low priority.
|
||||
@@ -0,0 +1,203 @@
|
||||
# Filter
|
||||
|
||||
| Environment variable | Description | Notes |
|
||||
|:---:|---|---|
|
||||
| `COUNTRY` | [Supported country](#supported-countries) you want to be scraped | Only used with `nvidia-api`, default: `usa` |
|
||||
| `MAX_PRICE_SERIES_3060TI` | Maximum price allowed for a match, applies 3060 Ti series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_3070` | Maximum price allowed for a match, applies 3070 series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_3080` | Maximum price allowed for a match, applies 3080 series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_3090` | Maximum price allowed for a match, applies 3090 series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_CORSAIR_SF` | Maximum price allowed for a match, applies to Corsair PSUs | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - PSUs above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_RYZEN5600` | Maximum price allowed for a match, applies AMD 5600 series cpus | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - CPUs above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_RYZEN5800` | Maximum price allowed for a match, applies AMD 5800 series cpus | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - CPUs above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_RYZEN5900` | Maximum price allowed for a match, applies AMD 5900 series cpus | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - CPUs above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_RYZEN5950` | Maximum price allowed for a match, applies AMD 5950 series cpus | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - CPUs above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_SONYPS5C` | Maximum price allowed for a match, applies PS5 console | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - PS5 above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_SONYPS5DE` | Maximum price allowed for a match, applies PS5 digital edition | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - PS5 above `1234` will be skipped. |
|
||||
| `MAX_PRICE_SERIES_TEST` | Maximum price allowed for a match, applies `test:series` | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - PS5 above `1234` will be skipped. |
|
||||
| `MICROCENTER_LOCATION` | Specific MicroCenter location(s) to search | Comma separated, e.g.: `marietta,duluth`, default: `web` |
|
||||
| `NVIDIA_ADD_TO_CART_ATTEMPTS` | The maximum number of times the `nvidia-api` add to cart feature will be attempted before failing | Default: `10` |
|
||||
| `NVIDIA_SESSION_TTL` | The time in milliseconds to keep the cart active while using `nvidia-api` | Default: `60000` |
|
||||
| `SHOW_ONLY_BRANDS` | Filter to show specified brands | Comma separated, e.g.: `evga,zotac` |
|
||||
| `SHOW_ONLY_MODELS` | Filter to show specified models | Both supported formats are comma separated <br/><br/>1. Standard E.g.: `founders edition,rog strix` <br/><br/> 2. Advanced E.g: `MODEL:SERIES`, E.g: `founders edition:3090,rog strix` |
|
||||
| `SHOW_ONLY_SERIES` | Filter to show specified series | Comma separated, e.g.: `3080,ryzen5900` |
|
||||
| `STORES` | [Supported stores](#supported-stores) you want to be scraped | Both supported formats are comma separated <br/><br/>1. Standard E.g.: `"nvidia"` <br/><br/> 2. Advanced E.g: `STORE:PAGE_SLEEP_MIN:PAGE_SLEEP_MAX`, E.g: `nvidia:10000:30000` <br/><br/>Default: `nvidia` |
|
||||
|
||||
## Supported stores
|
||||
|
||||
Used with the `STORES` variable.
|
||||
|
||||
| Stores | Environment variable |
|
||||
|:---:|:---:|
|
||||
| Adorama | `adorama`|
|
||||
| Alternate (DE) | `alternate`|
|
||||
| Alternate (NL) | `alternate-nl`|
|
||||
| Amazon | `amazon`|
|
||||
| Amazon (CA) | `amazon-ca`|
|
||||
| Amazon (DE) | `amazon-de`|
|
||||
| Amazon (DE) Warehouse | `amazon-de-warehouse`|
|
||||
| Amazon (ES) | `amazon-es`|
|
||||
| Amazon (FR) | `amazon-fr`|
|
||||
| Amazon (IT) | `amazon-it`|
|
||||
| Amazon (NL) | `amazon-nl`|
|
||||
| Amazon (UK) | `amazon-uk`|
|
||||
| AMD | `amd`|
|
||||
| AMD (CA) | `amd-ca`|
|
||||
| AMD (DE) | `amd-de`|
|
||||
| AMD (IT) | `amd-it`|
|
||||
| AntOnline | `antonline`|
|
||||
| Argos (UK) | `argos`|
|
||||
| Aria PC (UK) | `aria`|
|
||||
| ARLT (DE) | `arlt`|
|
||||
| ASUS | `asus` |
|
||||
| ASUS (DE) | `asus-de` |
|
||||
| Azerty (NL) | `azerty`|
|
||||
| B&H | `bandh`|
|
||||
| Best Buy | `bestbuy`|
|
||||
| Best Buy (CA) | `bestbuy-ca`|
|
||||
| Box (UK) | `box`|
|
||||
| CanadaComputers (CA) | `canadacomputers` |
|
||||
| Caseking (DE) | `caseking`|
|
||||
| CCL (UK) | `ccl`|
|
||||
| Comet (IT) | `comet`|
|
||||
| Computeruniverse (DE) | `computeruniverse` |
|
||||
| Coolblue (NL) | `coolblue`|
|
||||
| Coolmod (ES) | `coolmod`|
|
||||
| Corsair | `corsair`|
|
||||
| Currys (UK) | `currys`|
|
||||
| Cyberport (DE) | `cyberport` |
|
||||
| eBuyer (UK) | `ebuyer`|
|
||||
| El Corte Inglés | `elcorteingles`|
|
||||
| ePrice (IT) | `eprice`|
|
||||
| Euronics (IT) | `euronics`|
|
||||
| Euronics (DE) | `euronics-de`|
|
||||
| EVGA | `evga`|
|
||||
| EVGA (EU) | `evga-eu`|
|
||||
| Expert | `expert`|
|
||||
| Galaxus (DE) | `galaxus`|
|
||||
| Game (UK) | `game`|
|
||||
| Gamestop | `gamestop`|
|
||||
| Gamestop (DE) | `gamestop-de`|
|
||||
| Kabum (BR) | `kabum`|
|
||||
| Mediamarkt (DE) | `mediamarkt`|
|
||||
| Medimax | `medimax`|
|
||||
| MemoryExpress (CA) | `memoryexpress`|
|
||||
| Micro Center | `microcenter`|
|
||||
| Mindfactory (DE) | `mindfactory` |
|
||||
| Newegg | `newegg`|
|
||||
| Newegg (CA) | `newegg-ca`|
|
||||
| Notebooksbilliger (DE) |`notebooksbilliger`|
|
||||
| Novatech (UK) | `novatech`|
|
||||
| Nvidia | `nvidia`|
|
||||
| Nvidia (API) | `nvidia-api`|
|
||||
| Office Depot | `officedepot`|
|
||||
| Otto | `otto`|
|
||||
| Overclockers (UK) | `overclockers`|
|
||||
| PCComponentes (ES) | `pccomponentes`|
|
||||
| PlayStation | `playstation`|
|
||||
| PNY | `pny`|
|
||||
| Proshop (DE) | `proshop-de`|
|
||||
| Proshop (DK) | `proshop-dk`|
|
||||
| Saturn (DE) | `saturn`|
|
||||
| Scan (UK) | `scan`|
|
||||
| Smyths Toys (UK) | `smythstoys`|
|
||||
| Spielegrotte | `spielegrotte`|
|
||||
| Target | `target`|
|
||||
| Unieuro (IT) | `unieuro`|
|
||||
| Very (UK) | `very`|
|
||||
| Walmart | `walmart`|
|
||||
| Wipoid | `wipoid`|
|
||||
| Zotac | `zotac`|
|
||||
| TopAchat | `topachat`|
|
||||
|
||||
### Micro Center stores
|
||||
|
||||
Used with the `MICROCENTER_LOCATION` variable.
|
||||
|
||||
???+ note
|
||||
Before using `web`, please review [this issue comment](https://github.com/jef/streetmerchant/issues/442#issuecomment-703297393).
|
||||
|
||||
| | | | |
|
||||
|---|---|---|---|
|
||||
| `brooklyn` | `brentwood` | `cambridge` | `chicago` |
|
||||
| `columbus` | `dallas` | `denver` | `duluth` |
|
||||
| `fairfax` | `flushing` | `houston` | `madison-heights` |
|
||||
| `marietta` | `mayfield-heights` | `north-jersey` | `overland-park` |
|
||||
| `parkville` | `rockville` | `sharonville` | `st-davids` |
|
||||
| `st-louis-park` | `tustin` | `westbury` | `westmont` |
|
||||
| `yonkers` |
|
||||
|
||||
## Supported brands and models
|
||||
|
||||
Used with the `SHOW_ONLY_BRANDS` and `SHOW_ONLY_MODELS` variables.
|
||||
|
||||
| Brand | Model |
|
||||
|:---:|---|
|
||||
| `amd` | `5600x`, `5800x`, `5900x`, `5950x`, `amd reference` |
|
||||
| `asus` | `dual`, `dual oc`, `strix`, `strix oc`, `tuf`, `tuf oc` |
|
||||
| `corsair` | `750 platinum`, `600 platinum` |
|
||||
| `evga` | `ftw3`, `ftw3 ultra`, `xc3`, `xc3 black`, `xc3 ultra` |
|
||||
| `gainward` | `phantom gs`, `phoenix`, `phoenix gs`, `phoenix gs oc` |
|
||||
| `gigabyte` | `aorus master`, `aorus xtreme`, `eagle`, `eagle oc`, `gaming`, `gaming oc`, `turbo`, `vision`, `vision oc` |
|
||||
| `inno3d` | `gaming x3`, `ichill x3`, `ichill x4`, `twin x2 oc` |
|
||||
| `kfa2` | `sg`, `sg oc` |
|
||||
| `microsoft` | `xbox series x`, `xbox series s` |
|
||||
| `msi` | `gaming x trio`, `ventus 2x oc`, `ventus 3x`, `ventus 3x oc` |
|
||||
| `nvidia` | `founders edition` |
|
||||
| `palit` | `gamerock oc`, `gaming pro`, `gaming pro oc` |
|
||||
| `pny` | `dual fan`, `xlr8 revel`, `xlr8 uprising` |
|
||||
| `sony` | `ps5 console`, `ps5 digital` |
|
||||
| `xfx` | `merc`, `amd reference` |
|
||||
| `zotac` | `amp holo`, `amp extreme holo`, `trinity`, `trinity oc`, `twin edge`, `twin edge oc` |
|
||||
|
||||
## Supported series
|
||||
|
||||
Used with the `SHOW_ONLY_SERIES` variable.
|
||||
|
||||
| Series | Environment variable |
|
||||
|:---:|:---:|
|
||||
| `AMD Ryzen 5600x` | `ryzen5600` |
|
||||
| `AMD Ryzen 5800x` | `ryzen5800` |
|
||||
| `AMD Ryzen 5900x` | `ryzen5900` |
|
||||
| `AMD Ryzen 5950x` | `ryzen5950` |
|
||||
| `AMD RX 6800` | `rx6800` |
|
||||
| `AMD RX 6800XT` | `rx6800xt` |
|
||||
| `AMD RX 6900XT` | `rx6900xt` |
|
||||
| `Nvidia RTX 3060 Ti` | `3060ti` |
|
||||
| `Nvidia RTX 3070` | `3070` |
|
||||
| `Nvidia RTX 3080` | `3080` |
|
||||
| `Nvidia RTX 3090` | `3090` |
|
||||
| `Corsair SFX PSU` | `sf` |
|
||||
| `Sony PS5` | `sonyps5c` |
|
||||
| `Sony PS5 Digital Edition` | `sonyps5de` |
|
||||
| `Xbox Series S` | `xboxss` |
|
||||
| `Xbox Series X` | `xboxsx` |
|
||||
|
||||
## Supported countries
|
||||
|
||||
Used with the `COUNTRY` variable.
|
||||
|
||||
???+ attention
|
||||
Used _only_ with `nvidia` and `nvidia-api`.
|
||||
|
||||
| Country | 3080 FE | 3090 FE | Test Card | Notes |
|
||||
|:---:|:---:|:---:|:---:|:---:|
|
||||
| austria | `✔` | `✔` | `✔` | |
|
||||
| belgium | `✔` | `✔` | `✔` | |
|
||||
| canada | `✔` | `✔` | `✔` | |
|
||||
| czechia | `✔` | `✔` | `✔` | |
|
||||
| denmark | `✔` | | `✔` | Missing RTX 3090 |
|
||||
| finland | `✔` | | `✔` | Missing RTX 3090 |
|
||||
| france | `✔` | `✔` | `✔` | |
|
||||
| germany | `✔` | `✔` | `✔` | |
|
||||
| great_britain | `✔` | `✔` | `✔` | |
|
||||
| ireland | `✔` | `✔` | `✔` | |
|
||||
| italy | `✔` | `✔` | `✔` | |
|
||||
| luxembourg | `✔` | `✔` | `✔` | |
|
||||
| netherlands | `✔` | `✔` | `✔` | |
|
||||
| norway | `✔` | `✔` | `✔` | |
|
||||
| poland | `✔` | `✔` | `✔` | |
|
||||
| portugal | `✔` | | | RTX 3080 only |
|
||||
| spain | `✔` | `✔` | `✔` | |
|
||||
| sweden | `✔` | `✔` | `✔` | |
|
||||
| usa | `✔` | `✔` | `✔` | |
|
||||
@@ -0,0 +1,170 @@
|
||||
# Notification
|
||||
|
||||
You can test your notification configuration by running `npm run test:notification`.
|
||||
|
||||
## Desktop
|
||||
|
||||
| Environment variable | Description |
|
||||
|---|---|
|
||||
| `DESKTOP_NOTIFICATIONS` | Display desktop notifications using [node-notifier](https://www.npmjs.com/package/node-notifier). |
|
||||
| `PLAY_SOUND` | Play this sound notification if a product is found. Relative path accepted, valid formats: wav, mp3, flac, E.g.: `path/to/notification.wav`, [free sounds available](https://notificationsounds.com/) |
|
||||
|
||||
???+ attention
|
||||
If you're on Windows, you must have the proper library to run.
|
||||
|
||||
## Discord
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `DISCORD_NOTIFY_GROUP` | Discord group you would like to notify. Can be comma separated |
|
||||
| `DISCORD_WEB_HOOK` | Discord Web Hook URL. Can be comma separated. Use whole webhook URL |
|
||||
|
||||
???+ note
|
||||
- If you're using a role, please use `<@&2834729847239842>`
|
||||
- If you're using a user, please use `<@2834729847239842>`
|
||||
|
||||
## Email and SMS
|
||||
|
||||
Default provider is Gmail. If you use a different email provider, you must provide SMTP settings.
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `EMAIL_PASSWORD` | Email password. (See below for Gmail MFA users) |
|
||||
| `EMAIL_TO` | Destination Email. Defaults to username if not set. Can be comma separated |
|
||||
| `EMAIL_USERNAME` | Email address |
|
||||
| `PHONE_CARRIER` | [Supported carriers](#supported-carriers) for SMS. E.g.: `att` or `att,verizon,google`, email configuration required. If multiple phone numbers are listed, enter a carrier for each phone number |
|
||||
| `PHONE_NUMBER` | 10 digit phone number(s). E.g.: `1234567890` or `1234567890,0987654321,11112223333`, email configuration required |
|
||||
| `SMTP_ADDRESS` | IP Address or FQDN of SMTP server |
|
||||
| `SMTP_PORT` | TCP Port number on which the smtp server is listening for connections. Default: `25` |
|
||||
|
||||
???+ attention
|
||||
If you use Gmail and have multi-factor authentication (MFA), you will need to create an [app password](https://myaccount.google.com/apppasswords) and use this instead of your Gmail password.
|
||||
|
||||
### Supported carriers
|
||||
|
||||
| Carrier | Environment variable |
|
||||
|:---:|:---:|
|
||||
| AT&T | `att` |
|
||||
| AT&T Prepaid | `attgo` |
|
||||
| Bell | `bell` |
|
||||
| Fido | `fido` |
|
||||
| Google | `google`|
|
||||
| Koodo | `koodo` |
|
||||
| Mint | `mint`|
|
||||
| Rogers | `rogers` |
|
||||
| Sprint | `sprint`|
|
||||
| Telus | `telus`|
|
||||
| T-Mobile | `tmobile`|
|
||||
| Verizon | `verizon`|
|
||||
| Virgin | `virgin`|
|
||||
| Virgin (CA) | `virgin-ca`|
|
||||
| Visible | `visible`|
|
||||
|
||||
## MQTT
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `MQTT_BROKER_ADDRESS` | IP address or URL of MQTT Broker, e.g.: `192.168.1.xxx` or `broker.hivemq.com` |
|
||||
| `MQTT_BROKER_PORT` | Network port of MQTT Broker. Default: `1883` |
|
||||
| `MQTT_CLIENT_ID` | Unique Client ID (only if required by MQTT Broker), typically not required when only publishing alerts |
|
||||
| `MQTT_PASSWORD` | MQTT password - only use with MQTT brokers on private networks, if required. Will not be sent over public networks for safety |
|
||||
| `MQTT_QOS` | QoS level for published alerts to broker (https://www.npmjs.com/package/mqtt#about-qos). Default: `0`, Can be `0`, `1`, or `2` |
|
||||
| `MQTT_TOPIC` | Topic to publish alerts to. Can include `%store%`, `%series%`, `%brand%`, `%model%` for dynamic topics. Default: `streetmerchant/alert`. E.g.: `nv-alert/%store%/%series%/%brand%/%model%/alert` |
|
||||
| `MQTT_USERNAME` | MQTT username - (only if required by MQTT Broker) |
|
||||
|
||||
## PagerDuty
|
||||
|
||||
Obtained in PagerDuty - <Service you want to use> - Integrations
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `PAGERDUTY_INTEGRATION_KEY` | PagerDuty Events API v2 Integration Key. |
|
||||
| `PAGERDUTY_SEVERITY` | Severity of PagerDuty events |
|
||||
|
||||
## Philips Hue
|
||||
|
||||
Generate required keys using [instructions](https://developers.meethue.com/develop/get-started-2/). This will be used for both LAN and cloud access over the official Remote Hue API.
|
||||
|
||||
For cloud only usage, instructions to generate are located [here](https://developers.meethue.com/develop/hue-api/remote-authentication/).
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `PHILIPS_HUE_API_KEY` | Hue Bridge API Key |
|
||||
| `PHILIPS_HUE_LAN_BRIDGE_IP` | LAN IP Address of your Hue Bridge. LAN only, e.g. `192.168.x.x` |
|
||||
| `PHILIPS_HUE_LIGHT_IDS` | Light IDs. All lights if not supplied. Can be comma separated, e.g.: `1,2`. See Hue App -> About for IDs |
|
||||
| `PHILIPS_HUE_LIGHT_COLOR` | Color in RGB Format. Nvidia green if not supplied. Can be comma separated, e.g.: `255,255,255` |
|
||||
| `PHILIPS_HUE_LIGHT_PATTERN` | Lights will flash for 30 seconds if `blink` is given |
|
||||
| `PHILIPS_HUE_CLOUD_ACCESS_TOKEN` | Cloud Access Token. Cloud only |
|
||||
| `PHILIPS_HUE_CLOUD_REFRESH_TOKEN` | Cloud Refresh Token. Cloud only |
|
||||
| `PHILIPS_HUE_CLOUD_CLIENT_ID` | Cloud Client ID. Cloud only |
|
||||
| `PHILIPS_HUE_CLOUD_CLIENT_SECRET` | Cloud Client Secret. Cloud only |
|
||||
|
||||
> :point_right: Here's a [video demonstration](https://vimeo.com/476083242).
|
||||
|
||||
## Pushbullet
|
||||
|
||||
Generate token at https://www.pushbullet.com/#settings/account.
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `PUSHBULLET` | PushBullet API key |
|
||||
|
||||
## Pushover
|
||||
|
||||
Generate token at https://pushover.net/apps/build.
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `PUSHOVER_TOKEN` | Pushover access token |
|
||||
| `PUSHOVER_USER` | Pushover username |
|
||||
| `PUSHOVER_PRIORITY` | Pushover message priority |
|
||||
|
||||
## Slack
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `SLACK_CHANNEL` | Slack channel for posting |
|
||||
| `SLACK_TOKEN` | Slack API token |
|
||||
|
||||
## Telegram
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `TELEGRAM_ACCESS_TOKEN` | Telegram access token |
|
||||
| `TELEGRAM_CHAT_ID` | Telegram chat ID. Can be comma separated, e.g.: `123456789,987654321` |
|
||||
|
||||
## Twilio
|
||||
|
||||
Token generation can be found at https://twilio.com/console.
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `TWILIO_ACCOUNT_SID` | Twilio Account SID |
|
||||
| `TWILIO_AUTH_TOKEN` | Twilio Auth Token |
|
||||
| `TWILIO_FROM_NUMBER` | Twilio provided phone number to send messages from |
|
||||
| `TWILIO_TO_NUMBER` | Mobile number to send SMS to |
|
||||
|
||||
???+ note
|
||||
Include country codes in phone numbers. Example: `+4401234567890`
|
||||
|
||||
## Twitter
|
||||
|
||||
Generate all Twitter keys at: https://developer.twitter.com/
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `TWITTER_ACCESS_TOKEN_KEY` | Twitter Token Key |
|
||||
| `TWITTER_ACCESS_TOKEN_SECRET` | Twitter Token Secret |
|
||||
| `TWITTER_CONSUMER_KEY` | Twitter Consumer Key |
|
||||
| `TWITTER_CONSUMER_SECRET` | Twitter Consumer Secret |
|
||||
| `TWITTER_TWEET_TAGS` | List of hashtags to append to the tweet message, e.g.: `#nvidia #nvidiastock` |
|
||||
|
||||
## Twitch
|
||||
|
||||
| Environment variable | Description |
|
||||
|:---:|---|
|
||||
| `TWITCH_CLIENT_ID` | Twitch client ID |
|
||||
| `TWITCH_CLIENT_SECRET`| Twitch client secret |
|
||||
| `TWITCH_ACCESS_TOKEN` | Twitch access token |
|
||||
| `TWITCH_REFRESH_TOKEN` | Twitch refresh token |
|
||||
| `TWITCH_CHANNEL` | Twitch channel |
|
||||
Reference in New Issue
Block a user