What have you been watching ?
FreakTags is a simple media-tracker for you to keep up with all your favorite shows.
- Triage
- Contributor Guide - Coming soon
- Install rvm, Ruby(2.2), Rails(4.2), PostgreSQL
- Get inside the project folder and run:
bundle
rake db:create db:migrate db:seed
Problems? see our FAQ.md
Now that everything is set, lets start the server:
rails s
- Open
http://localhost:3000
on your favorite browser and see the magic
In order to create non-hard-coded use of params we use environment variables to manage several stuff, if you need to setup a server or test a specific feature please remember to set the .env file.
Check out the environment params you can set:
RAILS_ENV
- Rails environment. Ex.:development
,test
,beta
,production
.CODECLIMATE_REPO_TOKEN
- Code Climate token.FT_LOCALE
- Locale to language and currencies. Currently support:en
,pt-BR
.FT_NEWRELIC_KEY
- NewRelic API Key to monitor the app.FT_DEVISE_SECRET
- Devise unique secret to generate secure tokens.FT_HOST
- Server host domain or ip address.FT_MAIL_SENDER
- Default address to send email from. Ex.:noreply@yourhost.com
FT_MAIL_SERVER
- Default mail server. Ex.:mail.yourhost.com
FT_MAIL_PORT
- Default mail port. Ex.:587
FT_MAIL_TTLS
- Use TTLS. Ex.:true
,false
FT_MAIL_USERNAME
- Default mail username. Ex.:root@yourhost.com
FT_MAIL_PASSWORD
- Default mail password. Ex.:my$ecureP4$$w0rd
FT_MAIL_AUTH
- Default mail authentication style. Ex.:text
,login
FT_MAIL_DOMAIN
- Default mail domain. Ex.:beta.yourhost.com
,yourhost.com
FT_DATABSE_URL
- Database URL to connect with your DB.FT_GA_ID
- Google Analytics Tracking ID.
-
Core - App's main base
- Ruby - A dynamic, open source and elegant syntax programming language
- rvm - Ruby version manager
- Rails - an Open-source web framework optimized for programmer happiness and sustainable productivity
- Models
- enumerate_it - Awesome enum support gem
- friendly_id - Create slugs like a boss
- paranoia - act_as_paranoid for rails 4
- birthday - look for birthdays without a hassle.
- Models
- PostgreSQL - A powerful, open source object-relational database system.
- Server
- Ruby - A dynamic, open source and elegant syntax programming language
-
Authentication
- Devise - Flexible authentication solution for Rails with Warden
-
Authorizatoin
- CanCanCan - Authorization gem for RoR
-
Social
- PublicActivity - Easy activity tracking for models - similar to Github's Public Activity.
- ActsAsFollower - A Gem to add Follow functionality for models
-
Tests
- Rspec - RSpec meta-gem that depends on the other components
- Faker - A library for generating fake data such as names, addresses, and phone numbers
- FactoryGirl - A library for setting up Ruby objects as test data
- Capybara - Headless WebKit so you can test Javascript web apps
- Shoulda - Makes tests easy on the fingers and the eyes
- Poltergeist - PhantomJS driver for Capybara
- PhantonJS - A headless WebKit scriptable with a JavaScript API
- CodeClimate - Awesome test coverage tool
-
Development
- Bullet - Monitoring N+1 queries and unused eager loading
- Letter Opener - Preview mail in the browser instead of sending
- dotenv - Loads environment variables from
.env
-
Assets
- Rails Assets - Best solution to assets management in Rails
-
Deployment
-
Monitoring
- NewRelic - Really awesome app monitoring system