Skip to content

SeriouslyAwesome/democratictravelers

Repository files navigation

Circle CI Maintainability Test Coverage

The Democratic Travelers v4.5

This is the official code repository for TheDemocraticTravelers.com, a travel blog where visitors submit their suggestions of places/events for John and Laura to visit (and for Shane to visit them while they're visiting things), and others vote on the suggestions.

Overview

This project is a Ruby on Rails application that features an interactive map powered by a JSON API rendered with Handlebars templates and supported by token authentication, Mapbox, Leaflet, and the Google Places API, all written in object-oriented Coffeescript and jQuery. It's also got a full blog system that hooks into the data on the map to notify users by email when we've written about their submissions. Other goodies include social sign-in with OAuth, guest user accounts, plus Mailchimp and Instagram API integration. It's backed by a PostgreSQL database, and tuned for performance by taking advantage of background workers with Redis and Sidekiq to send emails and process image uploads, along with JSON caching, fragment caching, asset minification & compression, and eager loading. I also designed the front-end and styled it with Bourbon, Neat, and Bitters, with typography that falls on a proper baseline grid.

Prerequisites

  1. You'll need Redis installed: brew install redis
  2. You'll need PostgreSQL installed too.

Getting Started

Running bundle install and rake db:migrate should get your gems and DB setup. Then make sure Redis is running (redis-server) and fire up Sidekiq with bundle exec sidekiq.

Guard is implemented, and can be fired up with bundle exec guard, which will automatically run relevant specs, as well as Rubocop. If you don't like that, you can always bundle exec rspec.

Notes

This is a labor of love and always a work-in-progress. If you see something wrong or that could be better, please feel free to open an issue or a pull request.

About

An Airstream adventure with a crowd-sourced itinerary.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published