Scrape-o-matic NPM

scrape-o-matic

A website scraper, and email sender all in one!

scrape-o-matic aims to be an easy to use, highly configurable website scraper and email sender.

The primary use case for scrape-o-matic is to scrape specific content from any url, and send a customized email containing only that content. scrape-o-matic works best when run with a simple web server like Express. However, for this documentation, we will only be running scrape-o-matic by itself.

Playground 👩‍💻

Shut up and show me the code

Visit the scrape-o-matic playground to learn while you play.

Installation

Prerequisites

NodeJS must be installed on your machine. | Download NodeJS
NPM must be installed on your machine. If your NodeJS installation went well, NPM will be installed automatically. | Installing NPM

Install from NPM

npm install scrape-o-matic

Usage Examples

Basic

import scrapeOMatic from 'scrape-o-matic'

scrapeOMatic('https://www.google.com', {
  user: 'michael-scott@gmail.com',
  pass: 'worldsBestBoss',
  mailOptions: { 
    from: 'Prison Mike', 
    to: 'dwight-schrute@gmail.com',
    subject: 'Promotion 💰',
    html: <strong>This is an HTML email!</strong>
  }
})

Release History

1.0.0 (TBD 2019)

Changelog

Contributing

Fork it (https://github.com/alexlee-dev/scrape-o-matic/fork)
Create your feature branch (git checkout -b feature/fooBar)
Commit your changes (git commit -am 'Add some fooBar')
Push to the branch (git push origin feature/fooBar)
Create a new Pull Request

Related Projects

Coming Soon

Built With

Several technologies and services were utilized in the making of scrape-o-matic.

Documentation

Animate.css - Just-add-water CSS animation
Grommet - Focus on the essential experience
Marked - A low-level markdown compiler for parsing markdown without caching or blocking for long periods of time
React - A JavaScript library for creating user interfaces.
react-github-corner - Add a Github banner to your project page
Redux - A predictable state container for JavaScript apps