Getting Started Guide

Table of Contents Set up the software Download and configure a text editor Learn Ruby and Git Submitting code

Set up the software

First, you'll need to set up a copy of the otwarchive software. The easiest way to do this is with our Docker development environment, but experienced developers can also install and run the software locally:

• Set up the Archive on OS X using Homebrew
• Set up the Archive on Linux
• Set up the Archive on Windows (not recommended)

Download and configure a text editor

You will need a good text editor on your computer to edit the code. There are many freeware and cheap options:

• Linux: gedit, kedit (both free, already installed in most cases)
• Mac OS X: BBEdit (~$50, free option), TextMate (~$60)
• Windows: Notepad++ (free)
• All Platforms: Sublime Text (free never-ending trial, $70 to get rid of license reminder)
• All Platforms: Official OTW volunteers can also use the Archive's OpenSource license for JetBrains' RubyMine, a full-fledged IDE which allows you to debug code, manage remote repositories and Git, all from within one package.
• All Platforms: Visual Studio Code (free)

Whatever text editor you pick, you need to configure its settings or preferences so that you edit with the same style as all the other coders.

Change the settings/preferences to:

• convert all tabs to spaces
• make tabs 2 spaces wide
• use UTF-8 encoding (without byte-order mark, if that is offered as an option)
• use UNIX end-of-line characters

Learn Ruby and Git

If you're new to Ruby on Rails -- or if your skills are a little rusty -- there are a number of resources that can help:

• Try Ruby
• Codecademy: Ruby
• Codecademy: Ruby Glossary
• Getting Started with Rails
• Rails for Zombies
• Ruby Style Guide

There are also a variety of resources that can help you familiarize (or re-familiarize!) yourself with Git:

• Git Cheatsheet
• Learn Git Branching
• How to Write a Git Commit Message
• How To Write the Perfect Pull Request (And Review!)

Submitting code

If you're ready to write and submit some code, don't forget to adhere to our coding standards and review our commit policy and Contributing Guidelines.