Browse Source

add dockerignore and update docs

fix-broken-scrape
Jørgen Lien Sellæg 6 years ago
parent
commit
be7119166a
  1. 5
      .dockerignore
  2. 35
      README.md

5
.dockerignore

@ -0,0 +1,5 @@
node_modules
tests
.git
.gitignore
README.md

35
README.md

@ -1,41 +1,38 @@
# Facebook event scraper
A simple facebook event scraper written with node using puppeteer.
## Introduction
# Facebook page events scraper
Now you can get JSON representation of all events hosted by a Facebook page.
## Disclaimer
Please note that terms and conditions apply from Facebook and this script should
only be used if written consent is provided by Facebook.
## Dependencies for local install
## Dependencies
```sh
```txt
bash
node > v10
yarn > # tested with 1.22
node >= v10
yarn
google-chrome / chromium
```
## Usage
NOTE: You might want to set environment variables to use an existing chrome
install. (Voluntary)
``` sh
./scrape --help
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
export PUPPETEER_EXECUTABLE_PATH=/bin/google-chrome
```
## Examples
## Usage
```sh
./scrape PlanetRammstein
./scrape --skip-upcoming-events --past-events PlanetRammstein
```
### Alpine docker image is provided
### Usage with docker
```sh
rm -rf node_modules # If switching from a local install
docker build --tag facebook-scraper .
docker build --tag facebook-page-events-scraper .
docker run \
--rm \
--cap-add SYS_ADMIN \
facebook-scraper \
facebook-page-events-scraper \
scrape PlanetRammstein
```

Loading…
Cancel
Save