mirror of
https://github.com/opelly27/streetmerchant.git
synced 2026-05-20 05:17:35 +00:00
docs: add debian support and store info (#16)
Co-authored-by: Jef LeCompte <jeffreylec@gmail.com>
This commit is contained in:
@@ -49,9 +49,20 @@ You do not need any computer skills, smarts, or anything of that nature. You are
|
||||
- Run `npm install`
|
||||
- Edit the `.env` file to your liking
|
||||
- More on this in [customization](#Customization)
|
||||
- Run `npm run start`
|
||||
- Run `npm run start` to start
|
||||
|
||||
Then watch the magic happen!
|
||||
At any point you want the program to stop, use <kbd>Ctrl</kbd> + <kbd>C</kbd>.
|
||||
|
||||
### Additional Linux dependencies
|
||||
|
||||
<details>
|
||||
<summary>Debian based OSes</summary>
|
||||
|
||||
```
|
||||
ca-certificates fonts-liberation libappindicator3-1 libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Customization
|
||||
|
||||
@@ -63,10 +74,21 @@ First, you're going to need to copy the `.env.example` to `.env`. The current op
|
||||
|:---:|:---:|
|
||||
| `EMAIL_USERNAME` | Gmail address; e.g. `jensen.robbed.us@gmail.com` |
|
||||
| `EMAIL_PASSWORD` | Gmail password; see below if you have MFA |
|
||||
| `STORES` | List of stores you want to be scraped; optional, default: `nvidia` |
|
||||
| `STORES` | List of [stores](#Supported-stores) you want to be scraped; optional, default: `nvidia` |
|
||||
|
||||
> :point_right: If you 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 stores
|
||||
|
||||
| **Store name** | **Store name environment variable** |
|
||||
|:---:|:---:|
|
||||
| Best Buy | `bestbuy`|
|
||||
| B&H | `bandh`|
|
||||
| Newegg | `newegg`|
|
||||
| Nvidia | `nvidia`|
|
||||
|
||||
> :point_right: Look at [`.env.example`](.env.example) for an example for `.env`.
|
||||
|
||||
## FAQ
|
||||
|
||||
**Q: 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.
|
||||
|
||||
Reference in New Issue
Block a user