Weather App is a Ruby gem with a CLI (command line interface). It utilizes API from OpenWeatherMap. On start up, the app will welcome the user and ask for a US zipcode. The User enters a valid US zipcode to view the main weather and temperature for the next 5 days. Then, the user can hit any key to restart the session.
To get started locally, follow the steps:
- Navigate to the repo https://github.com/chienleow/weather_app
- Click the green button "Clone" on the top right and copy the remote URL from "Clone with SSH"
- Type
git clonethen paste the copied URL into your terminal - Install dependencies with
bundle install - Sign up for a free account to get an API key from https://openweathermap.org/api
- Follow the steps to hide your API key How to hide your API keys
- Add your API key in
.envfileOPEN_WEATHER_MAP_API_KEY = 'YOUR_API_KEY'
To run Weather App from your command line, type the below and follow the on screen prompts.
bin/weather
After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/chienleow/weather_app. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the WeatherApp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.