daniloisr / twitter-on-rails

Simple Twitter API consuming APP

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twitter Challenge

Decisions

I used the gem sferik/twitter because its read-to-use API authentication, response parsing and my previous experience with it. It was not necessary due the simplicity of the app, but considering the only 2 hours to build the app... ;)

For authentication I choose Devise Gem.

Local environment setup instructions

Add your twitter app credentials (TWITTER_CONSUMER_KEY, TWITTER_CONSUMER_SECRET) as environment variables, or fill .env file.

Setup the database filling up the config/database.yml file, there is an example file config/database.yml.sample.

Basic Heroku deployment instructions

Add heroku in your git remotes with heroku git:remote -a HEROKU_APP_NAME. Read more at this heroku guide.

Test suite setup/execution instructions

Edit the database file and run rake db:test:prepare to finish your database setup, them run rake test to run the tests files.

TODO

  • Add tests to tweet_with_mentions helper.
  • Improve styles

About

Simple Twitter API consuming APP


Languages

Language:Ruby 82.5%Language:HTML 13.4%Language:CSS 2.7%Language:JavaScript 1.5%