Fig77 / Halpin-hand

Web Scrapper project that will attempt to get rid of a few annoying tasks of my regular life. Developed with Ruby.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Issues

menu

✋Halpin Hand ✋

Capston project (Ruby ♦️)
Explore the docs »

About The Project

Halpin is a web scraper that will perform a set of different tasks, like showing particular information taken from the web, based on user input. Made with Ruby & Nokogiri for scrapping♦️

Table of Contents

Built with

  • Nokogiri
  • Mechanize
  • Colorize
  • RSpec

Installation

Prerequisites

The development environment uses Ruby, hence install ruby before proceeding.

  • Mac OS - brew install ruby
  • Linux - sudo apt-get install ruby-full
  • Windows - Download RubyInstaller here, run it, and you are done!

  1. You can download the zip project clicking here or you can clone the project using the command - git clone https://github.com/Fig77/Halpin-hand.git
  2. If you are in windows, just navigate to the Halpin-hand/bin and click on main to start the app. On Linux, navigate with console using cd command and then write ruby bin/main.rb
  3. Run bundle to install extra gems needed to load ( command bundle install on the command line, or install with gem install [name] the gems listed here that says requires to install ). Need help with bundle?

How to Use

Instructions

  • Once you enter the app, you'll be greeted by the Menu. In there you'll see which functions (of those that appear on-screen) are currently active, what will be next, and what will probably take a bit longer.

menu

* You can then press the correspondent number, and enter to proceed. Once the task is complete, you'll be returning to this menu.

Santa-fe events by date

  • Here the app will scrape through Santa-Fe's city website and will get events with start time and location of a given specific date. If no event is found, nothing will be shown. If an invalid date is entered, you'll be returning to the menu.
  • After date format is shown, you'll be expected to enter a date with said format.

menu

Testing

Testing was done using RSpec. You can run the tests with the following command

bundle exec rspec

Future Improvements

  • Translation from received data into English

See the open issues for a list of proposed features (and known issues).

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Contact📱

About

Web Scrapper project that will attempt to get rid of a few annoying tasks of my regular life. Developed with Ruby.

License:MIT License


Languages

Language:Ruby 100.0%