For coders - nla-pgh/website GitHub Wiki

This document lists the software used for the website. Anyone that's going to touch the codebase should be comfortable with programming (and the process of debugging) and should be willing to learn new frameworks. With this prerequisite, this document will only provide the list of software and the URL leading to relevant resources. This document does not teach programming.

Core Software

Ruby on Rails: A Modle-View-Controller web framework. It's noteworthy to checkout Ruby on Rails application layout.
Refinery CMS: A content management system built on Ruby on Rails
Twitter Gem: A Ruby Gem that wraps the Twitter API
Heroku: The Platform-as-a-Service used for deploying Ruby on Rails applications, among others.
Git: A fast Version Control System used to upload to Github and deploy to Heroku.

Complete list of Gems used is listed in the Gemfile.

Key Directories and Files

  app/
  app/views/shared/
  app/views/refinery/
  app/views/layout/
  app/assets

  config/

Refer to Rails key directories here.

Key Commands

  rake db:setup
  rake db:migrate
  rake db:reset
  RAILS_ENV=production rake assets:precompile

  git status
  git add -A .
  git push heroku master

Imperatives

Prior to every deployment to Heorku, make sure to run RAILS_ENV=production rake assets:precompile so the changes are propagated to the frontend.

⚠️ GitHub.com Fallback ⚠️