Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/splode/obake
Obake automates checking online merchants for deals and inventory.
https://github.com/splode/obake
automation deals headless-chrome merchants puppeteer typescript
Last synced: 8 days ago
JSON representation
Obake automates checking online merchants for deals and inventory.
- Host: GitHub
- URL: https://github.com/splode/obake
- Owner: Splode
- License: mit
- Created: 2021-04-27T04:23:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T11:22:05.000Z (almost 2 years ago)
- Last Synced: 2023-02-27T02:11:26.735Z (over 1 year ago)
- Topics: automation, deals, headless-chrome, merchants, puppeteer, typescript
- Language: TypeScript
- Homepage:
- Size: 790 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Obake
> Obake automates checking online merchants for deals and inventory.
Periodically check online stores for goods, and be alerted when inventory is available or on sale.
## Installation
Install with npm:
```sh
npm install -g @splode/obake
```
Alternatively, clone this repo and link:
```sh
npm install && npm link
```
## Usage
Obake requires [configuration](#configuration).
```sh
obake [options]
```
Run Obake, specifying the config file path:
```sh
obake --config "example.toml"
```
### Configuration
Obake uses [TOML](https://toml.io/en/) for its configuration. An example configuration file, [example.toml](./example.toml), is provided as a starting point.
#### Notifications
Obake currently supports the following, optional types of notifications:
- Desktop
- Email
- Telegram
#### Adding Goods
To add a good, simply add an entry to the `goods` config:
```toml
[[goods]]
URL = "https://example.org/someproduct" # string
name = "A Pretty Name for Display" # string
price = 199.99 # number
```
Obake will notify you if the item is in stock and _below_ the given price.
### Supported Merchants
- Amazon
- Apple App Store
- B&H Photo*
- Best Buy
- Costco
- JensonUSA
- NewEgg
- REI
- WalMart
- Zavvi
* Note: you may encounter aggressive anti-bot detection with these merchants.