Giter VIP home page Giter VIP logo

khaledalmana / wishlist-importer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alghaliyahm/wishlist-importer

0.0 0.0 0.0 171 KB

✨ Wishlist Importer provide wishlist data for the supported domains in the library. Wishlist Importer manipulate HTML and fetch the data for the given sharable wishlist Url, given you a clean items data where you can import and use in your system.

License: MIT License

JavaScript 1.44% TypeScript 98.56%

wishlist-importer's Introduction

✨Wishlist Importer

The greate library for scraping and importing sharable wishlist data.

Features

Wishlist Importer provide wishlist items data for the supported domains in the library. the library manipulate HTML and fetch the data for the given sharable wishlist Url, given you a clean items data where you can import and use in your code.

Installation

npm install wishlist-importer

Test

Test your code with Jest framework:

npm run test

Build

Build production (distribution) files in your dist folder:

npm run build

Usage

import {Scraper} from 'wishlist-importer'

// pass your sharable wishlist url to get the data..
const scraper = new Scraper();
const wishlistItems = await scraper.wishlistScraper("https://example.com");

/*
expected output >> array of items
[
  {
    item_name: '...',
    item_price: '...',
    item_img: '...',
    item_url: '...'
  }
  ,
  {
    item_name: '...',
    item_price: '...',
    item_img: '...',
    item_url: '...'
  }
]

*/

Supported Domains

For now wishlist-importer supports three Domains

  • mamasandpapas
  • amazon
  • ounass

Contributing

You are welcome to contribute to ✨wishlist-importer! you can add more domain to be supported by the library. Please check the guidline below.

Guidline

You should fork the repository, make changes in your own fork, and then submit a pull request. Ensure the new code changes have associated unit tests. Additionally, for adding new domain the new code should follow the structure implemented. First you can add in (src/enum) css selector for the added domain, next you can add the logic in (src/scraper), and lastly add the test case to validate the new code.

NOTE: cheerio library is used for parsing and manipulating HTML and does not support XPath.

wishlist-importer's People

Contributors

alghaliyahm avatar khaledalmana avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.