Skip to content

raoul2000/bob-the-miner

Repository files navigation

What ? another web scraper ? ...yeah, that's Bob !

What about reading the doc ?

Install

To use Bob in your own project :

npm install bob-the-miner --save

If you want to contribute :

git clone https://github.com/raoul2000/bob-the-miner.git
cd bob-the-miner
npm install

Test

Test are based on Mocha which is supposed to be installed globally and accessible on your environment. If you need to install Mocha :

npm install --global mocha

To check it is installed, display its version number:

> mocha --version
2.4.5            

Now you are ready to run tests. First start the test local server :

npm run server

Then open another shell run the tests :

npm test

Examples

  • extract titles from the nodejs new website
npm run nodejs-news
npm run nyt-headline
  • extract packages list from NPM website
npm run npm-crawler

Documentation

Documentation is based on vuepress.

To view the documentation running a local server :

npm run docs:dev

If the error error:0308010C:digital envelope routines::unsupported is reported during local dev server startup, try to first define export NODE_OPTIONS=--openssl-legacy-provider and re-run the command. (see this thread for more)

To build the documentation :

npm run docs:build

Then copy the generated files from docs/.vuepress/dist to another (temporary) folder outside of the project, switch the the branch gh-pages and copy back the files. Then commit and push.

About

Bob is a miner that will digg the web to extract precious data for you

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published