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

1. NodeJS must be installed on your machine. | Download NodeJS
2. 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: '[email protected]',
  pass: 'worldsBestBoss',
  mailOptions: { 
    from: 'Prison Mike', 
    to: '[email protected]',
    subject: 'Promotion 💰',
    html: <strong>This is an HTML email!</strong>
  }
})

Release History

• 1.0.0 (TBD 2019)

Changelog

Changelog

Meta

Alex Lee – @alexlee_dev – [email protected]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/alexlee-dev/

Contributing

1. Fork it (https://github.com/alexlee-dev/scrape-o-matic/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. 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

Style

• Comfortaa - Font

Site

• Netlify - Build, deploy, and manage modern web projects

Functionality

• babel - A JavaScript compiler
• chalk - Terminal string styling done right
• nodemailer - Send e-mails from Node.js – easy as cake! 🍰✉️
• request - Designed to be the simplest way possible to make http calls

Inspired By

• React Toastify's Playground React notification made easy
• Docsify - A magical documentation site generator
• Google's Settings Menu - Google's Settings Menu

Attribution

Scraper Icon made by Freepik from www.flaticon.com is licensed by CC 3.0 BY.