Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add playground environment, inspired heavily from israeli-ynab-updater #116

Merged
merged 2 commits into from
Jun 10, 2018
Merged

add playground environment, inspired heavily from israeli-ynab-updater #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b700acf
add playground environment, inspired heavily from israeli-ynab-updater
eransakal Apr 14, 2018
e1d9b73
update instruction to user when saving playground options
eransakal May 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ typings/
lib/

# IDEs
.idea
.idea
3 changes: 3 additions & 0 deletions .npmignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Remove ES6 source
src/

# Remove Playground
playground/
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ Any kind of help is welcome, even if you just discover an issue and don't have t
## Filing issues
While there's no specific template for creating a new issue, please take the time to create a clear description so that it is easy to understand the problem.

## Using the playground
> With the integrated playground support, you can easily extend the scrapers and also enjoy the IDE debug feature if needed.

Once you prepare the playground environment you will be able to set scraping options, debug using the IDE and get the scraped transactions as generated csv files.

### Setup playground options & credentials
run `npm run setup` and use the interactive menu to setup both playground options and relevant scrapers credentials.

### Run a scraper
run `npm start` to execute the playground scraper.

### Debug your changes using the IDE
To run the playground scripts within your IDE debugger, make sure you configure debug node with the following parameters:
- *Node Parameters:* `-r babel-register`
- *Javascript file :* `playground/scrape.js`

Feel free to add breakpoints in the `src` folder, it should work smoothly.

## Submitting PRs
Again, no template, but please try to create something of the form:

Expand Down
Loading