Skip to content

l-portet/pizzadoor-stocks-manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

68 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Pizzadoor stocks manager

๐Ÿ•๐Ÿค– Stocks manager for Adial pizza ATM (pizzadoor)

Installation

  npm install pizzadoor-stocks-manager

Usage

Quick start

const PizzadoorStocksManager = require('pizzadoor-stocks-manager');

const config = {};
const credentials = {
  adial: {
    username: 'my-username',
    password: 'my-super-secret-password',
  },
};

let manager = new PizzadoorStocksManager(config, credentials);

manager.fetchAndManage().then(atmsData => console.log(atmsData));

Credentials

Here are all the credentials that might be required to work properly.

const credentials = {
  adial: {
    username: 'my-username',
    password: 'my-super-secret-password',
  },
  sendgrid: {
    apiKey: 'my-api-key',
  },
};

Config

Take a look at the sample.config.js file at the root of the repo to get all the possible settings available.

Issues

Found a bug? Feel free to contact me or open an issue on github. You can also contribute by creating a pull request.

Improvements

This project has recently been migrated to Typescript due to an external need. The typeness support is partial and mostly ensured to have type at the external interface. The internal code is not properly typed. Since a lot of the code is scraping, its format is not stable and it is not easy to type. If you are interested in improving the typing, please feel free to submit a PR.

About

๐Ÿ• Stocks scraper & manager for Adial pizza ATM (Pizzadoor)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published