Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.91 KB

getting-started.md

File metadata and controls

37 lines (27 loc) · 1.91 KB

Getting Started

Once you've successfully followed the steps outlined in the README, you're good to go! However, if you'd like to also set up this project to work with an IDE or have some other questions, this is a good place to start.

Core Technologies

As an open-source project, this application would not be possible without the labor of countless others. We try to maintain an up-to-date list of core technologies we use and build upon. Check it out!

What is Vagrant?

Per the official tool's website:

Vagrant lowers development environment setup time, increases production parity, and makes the "works on my machine" excuse a relic of the past

At first Vagrant may seem magical and hard to understand, so you may find it worthwhile to read the official quickstart guide. We promise it's worth it!

Setting up the IDE -- RubyMine

As our application uses Ruby on Rails as its development framework, most of our developers use RubyMine for development. A free student download of the software can downloaded here.

After following the "Getting Up and Running" section from the primary README, we will need to configure RubyMine to use Vagrant and Ruby.

  1. Download and open up RubyMine.
  2. Open up Preferences
  3. Navigate to Languages and Frameworks
  4. Navigate to Ruby SDK and Gems
  5. Use the + button in the upper left corner to add a "New remote..."
  6. Choose the Vagrant option and in the "Ruby or version manager path" click the folder icon
  7. Select home/vagrant/.rvm/bin/rvm in the pop-up menu
    • After clicking ok, ensure you've selected this remote in the sidebar!
  8. Click ok and apply the settings.

You should now be able to click the play button in the upper-right corner to launch the server!