Features

Initial Application Spec

• Initial design work
• Custom user sign up
• Signing in
• Sign in with GitHub
• User "profile" pages
• Basic Language functionality
• Basic Snippet functionality
• Private snippets
• Commenting on snippets
• "Smart" default front page
• Notifications (just comments)
• Snippet tagging
• Search (Probably not full text, just tags)
• Public API
• Atom integration

The Things

The Language

Ruby - a dynamic scripting language with a focus on simplicity

The Framework

Rails - a popular MVC web framework built on ruby

The Database

PostgreSQL - a fast, secure, and modern relational database

The Server

Heroku - a free-to-use cloud application platform focusing on hosting web applications

The Version Control System

Git - a very popular distributed version control system

GitHub - a git repository hosting service

Getting Started

1. Open a terminal and change to the repository directory

$ pwd
/Users/yourusername
$ cd path/to/repo

2. Make sure that all required packages are installed

$ bundle install

3. Make sure that all database migrations have been run

$ bundle exec rake db:migrate

4. Put some seed data in your development database

$ bundle exec rake db:seed

5. Start up the rails server

$ rails server

Other Useful Things

• Sublime Text - a popular text editor
• Screenhero - screen sharing made for remote developers
• IRC - We can use the IRC channel #lsucompsci on freenode to talk about the project