🟠 Draft | A tool to dissect of websites
Go to file
Glenn Y. Rolland 2c6ecde8be
Update README.md
2018-10-11 11:33:00 +03:00
bin Improve code 2018-09-21 01:25:39 +02:00
exe Rename webgalien to webgalen (to respect english/greek name) 2018-10-11 11:10:01 +03:00
lib Rename webgalien to webgalen (to respect english/greek name) 2018-10-11 11:10:01 +03:00
.gitignore Move cache to tmp 2018-10-11 10:56:53 +03:00
.rubocop Improve code 2018-09-21 01:25:39 +02:00
Gemfile Add rasem gem for SVG generation 2018-10-11 10:57:37 +03:00
Gemfile.lock Rename webgalien to webgalen (to respect english/greek name) 2018-10-11 11:10:01 +03:00
LICENSE.txt Add LICENSE file 2018-10-11 11:15:01 +03:00
README.md Update README.md 2018-10-11 11:33:00 +03:00
webgalen.gemspec Rename webgalien to webgalen (to respect english/greek name) 2018-10-11 11:10:01 +03:00

README.md

Webgalen

A tool to dissect of websites (tribute to Galen of Pergamon)

It is able to :

  • crawl websites to create a sitemap,
  • uses the sitemap to create website screenshots (full page length)

Roadmap (⚠️ work in progress/unstable)

  • device profiles selection for screenshots
  • compare screenshots to produce a diff (i already have a fully fonctional side-project for that, waiting to be integrated and automated in webgalen)
  • annotate screenshots (define a bounding-box => add comment + red/green figures like the ones on trello => produce screenshot slices)
  • push annotation + slices on a project management tool (ex: trello, redmine, etc.)
  • use annotation bounding-box + diff to detect which comments are involved in a diff (modifié)

Prerequisites

Install a few tools

apt-get install img2pdf imagemagick

Increase memory in imagemagick policy /etc/ImageMagick-6/policy.xml

<policy domain="resource" name="memory" value="2GiB"/>

Usage

$ be exe/webgalen
Commands:
  webgalen help [COMMAND]    # Describe available commands or one specific command
  webgalen list-devices      # list available profiles
  webgalen screenshot FILE   # take screenshots for each page
  webgalen sitemap URL FILE  # crawl site and export sitemap

Options:
  -ua, [--user-agent=USER-AGENT]  # choose user agent (default Mozilla)

Contributing

  1. Fork it ( http://github.com/glenux/webgalen/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Credits

Author & Maintainer: Glenn Y. ROLLAND

Contributors: none yet ;)

Got questions? Need help? Tweet at @glenux

License

Webgalen is Copyright © 2018 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE file.