Skip to content

Latest commit

 

History

History
152 lines (123 loc) · 5.32 KB

README.md

File metadata and controls

152 lines (123 loc) · 5.32 KB
Raw

Weather Widget

A Mini weather widget application developed in sintra and Angular 1.5.x that can fetch the current weather forecast in the user's current location (working with both IP location and HTML5 geolocation).

Features

  • Fully Responsive
  • Geolocation support built in, with fallback to IP based location
  • Ability to change the widget's forecast location through the UI
  • Fully developed API for fetching information about the current weather and week forecasts.
  • Integration with Yahoo! Weather API.

System Requirements

Make sure you have the following software installed on your server:

Software Version Installation
Ruby >= 2.0.0 Specific for the OS. More information here
Bundler gem >= 1.12.x gem install bundle
rackup Gem >= 1.3 gem install rackup
Apache or nginx N/A specific for the OS.

Frameworks and APIs used

Clone this repository by Running:

$ git clone https://github.com/androide-osorio/weather-widget.git

Next, cd into the project's folder that you just cloned and run

$ bundle install

To run a local development server where you can see the project up and running, use the command:

$ bundle exec unicorn -p 5000 -c ./config/unicorn_development.rb

This will open a test server in http://localhost:5000.

Configuring the application

Currently, there is only one setting that can be configured: the default location the weather widget will load.

To configure it, open the application.rb file and look for the following line:

# replace the value in quotes to change the location
set :location, 'Los Angeles, CA, United States'

Deploying to Production

To have this application running in a production server, you'll first need to have a web server installed. The following instructions are valid for the following setup:

  • nginx as web server
  • unicorn as the ruby application server
  • Ubuntu 14.04+

Installing production software

Make sure you first install ruby into the server by running:

$ sudo apt-get upgrade
$ sudo apt-get update
$ sudo apt-get install ruby-full

Verify these commands were successful by running ruby -v. Next, install nginx in your server by running:

$ apt-get install nginx

Install the Unicorn gem by running:

$ gem install unicorn

Once you have installed this software, please open the config/unicorn_production.rb file and configure the correct routes and names the Unicorn server will use (in the provided file, replace /path/to/whatever for the appropiate path):

# Set the working application directory
working_directory "/var/www/weather-widget" # REPLACE THIS!

Next, configure the nginx web server by creating a new configuration file:

# Remove the default configuration file
rm -v /etc/nginx/sites-available/default

# Create a new, blank configuration
nano /etc/nginx/conf.d/default.conf

note: You may need to use sudo to perform this actions.

Configure the nxginx server accordingly (/etc/nginx/conf.d/default.conf), so it can communicate properly to the Unicorn gem. an example configuration is written below (make sure to replace the configurations accordingly):

upstream app {
    # Path to Unicorn SOCK file, as defined previously
    # ("listen" call in ./config/unicorn_production.rb, line 13)
    server unix:<unicorn socket defined in unicorn_production.rb> fail_timeout=0;
}

server {
    listen 80;

    # Set the server name, similar to Apache's settings
    server_name localhost;

    # Application root, as defined previously
    root /path/to/weather-widget/public;

    try_files $uri/index.html $uri @app;

    location @app {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_redirect off;
        proxy_pass http://app;
    }

    error_page 500 502 503 504 /500.html;
    client_max_body_size 4G;
    keepalive_timeout 10;

}

You can now start the unicorn process by running:

# Make sure that you are inside the application directory
unicorn -c ./config/unicorn_production.rb -D

And restart nginx to refresh the new configuration:

$ service nginx restart

There are a lot of other ways to deploying to production depending on your configuration. You can find more information in this great article, where you can see the above configuration in more detail and how to configure an Apache server as well.

Authors

  • Graphic and UX design by Hernando Botero.
  • Development by Andrés Osorio.