README

Sitedish-scraper

About

Sitedish-scraper scrapes the SiteDish consumer restaurant website to get all categories and dishes. The resulting list is returned in JSON format.

Developed in collaboration with a Sushi 81. Delivery and take-away restaurant of sushi and Poke Bowls. Located in Nijverdal, the Netherlands. https://sushi81.nl

Install

You can either install it as local dependency to a project, or install it globally.

To install sitedish-scraper globally:

$ npm install -g sitedish-scraper

Once installed globally, you can run it on the command line from any location.

Usage Command Line

To list all current dishes and categories for example, execute sitedish-scraper with the --url option. Optionally add the --verbose flag for extra verbosity of logging.

$ sitedish-scraper --url <public-website> [--verbose]

$ sitedish-scraper --url https://bestellen.sushi81.nl

For example, the output of the command above looks like this:

"categories": [
    {
        "category": "Poke bowl",
        "categoryDescription": "Poké (spreek uit als pokay) is een traditioneel gerecht uit Hawaï, waar verse vis en groente centraal staat. Een Poké bowl bestaat uit vis of vlees, gemarineerd in een kom met sushirijst, groente en eventueel andere toppings zoals zeewier. Poké bowl is de populaire culinaire trend van dit moment!"
    }
],        
"products": [
    {
        "id": 1,
        "number": "1",
        "name": "Poké Bowl kip yakitori",
        "price": 715,
        "categorie": "Poke bowl",
        "description": "Kip op Japanse wijze, edamame, komkommer, wakame en sushirijst",
        "choices": [ {
            "id": 45,
            "name": "Normaal",
            "price": 0 
            }, 
            {
            "id": 46,
            "name": "Groot",
            "price": 580
        } ]
    },
    {
        "id": 2,
        "number": "2",
        "name": "Poké Bowl ossenhaas",
        "price": 895,
        "categorie": "Poke bowl",
        "description": "Kort geroosterde ossenhaas in teriyaki, edamame, komkommer, wakame en sushirijst"
    }
]

Usage in Code

We assume npm is installed and the project already contains a package.json file. If not, then first initialize the project.

$ npm init

Install sitedish-scraper as node module and save it to package.json:

$ npm install sitedish-scraper --save

Add sitedish-scraper to your program with require and call scrape() with the SiteDish website URL encapsulated within a configuration object:

const sitedishScraper = require('sitedish-scraper');
const options = {
    url: 'https://bestellen.sushi81.nl',
    verbose: false
};
sitedishScraper.scrape(options)
    .then(products => {
        // Pretty print products to console.
        console.log(JSON.stringify({products}, null, 4));
    })
    .catch(error => {
        console.log('ERROR: Failed to load the products:');
        console.log(error);
    });

Development

Code style

JavaScript project code style:

https://github.com/standard/standard

Usage no npm install needed!