https://github.com/brianpetro/reddit-ads

https://github.com/brianpetro/reddit-ads

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/brianpetro/reddit-ads
• Owner: brianpetro
• Created: 2015-04-06T20:10:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-04-15T18:14:06.000Z (over 9 years ago)
• Last Synced: 2024-12-22T05:29:25.242Z (12 days ago)
• Language: Ruby
• Size: 484 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc

Awesome Lists containing this project

README

        
== README

=== Built for deployment on Heroku

=== Demo: https://mysterious-bastion-5466.herokuapp.com/

=== API/Secret Keys

Local api keys are kept in a '.env' file that is not committed to the git repo. The '.env.example' file is provided as boilerplate.

Production api key should be handled responsibly(use 'heroku config:set' feature) and not commited to git.

==== Required ENV to Work

- MANDRILL_APIKEY

- MANDRILL_USERNAME

- FROM_EMAIL

- PRODUCTION_DOMAIN

=== Dotenv Values to Set

- Domain

- Mandrill API key and username

- from email

=== CDN Configuration

- Allowed HTTP methods: GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE

- simple AWS CloudFront CORS setup: http://blog.cloud66.com/cross-origin-resource-sharing-cors-blocked-for-cloudfront-in-rails/

=== Social Networks / Share Links

==== Share Link Config

Set required variable values in /app/helpers/home_helper.rb

=== Meta Tags

- Uses metamagic. See https://github.com/lassebunk/metamagic

- Open graph http://ogp.me/

- Twitter cards(and open graph fallback) https://dev.twitter.com/cards/markup

=== CSS Assets

==== Bootstrap 3.3.4

Served via vendor/assets

==== Bootstrap Material Design Theme

Included via gem: https://github.com/Aufree/bootstrap-material-design

==== Font Awesome 4.3

Included via font-awesome-rails gem

=== Split Testing

Split tests are run by injecting a piece of JavaScript that adjusts the page as required.

=== Tracking Email Submissions

URL parameter 'i' is the default tracking parameter. The User.tracker attribute will be set as the parameter's value if present.

- Example URL 'http://launchapp.example.com/?i=my-facebook'

A tracking cookie is store for 3 days when a tracking parameter is used.

== Todo

=== Tests

- JavaScript should set user_tracker input value to 'i' parameter 

=== DEPRECATED

- figure out situation with DEPRECATED _path in mailer views, in favor of _url