Skip to content

JulioGMedina/yourjargon

 
 

Repository files navigation

yourjargon - A Private Maintainable Glossary

This web application shows the power of Rails and EmberJS to provide a powerful client side experience. Advanced BDD and TDD test tools such as Cucumber and Jasmine are used to drive out the functionality.

What Does this Web Application Do?

TODO

Installation

Prerequisites

  • Mac OS X
  • Snow Leopard or Lion
  • 64 bit

Preparation

A number of open-source packages are required:

Xcode

Install Xcode and the necessary SDK for development (gcc, various tools, libraries, etc).

Qt Binary Package

Install Qt binary package. NOTE: Download and install the first dmg file: http://get.qt.nokia.com/qt/source/qt-mac-opensource-4.8.0.dmg

rvm

Use rvm to keep your entire Ruby/Gem installation for this project separate from your others if you haven't already.

To install:

bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer )

Install Ruby 1.9.3-p0 and the Ruby Gems

Using rvm:

rvm install ruby-1.9.3-p0
rvm use ruby-1.9.3-p0
rvm gemset create yourjargon
gem install bundler --no-ri --no-rdoc
bundle install

This last step will take a few minutes. When done:

phantomJS

phantomJS is a headless WebKit with JavaScript API. We're going to use it as a javascript engine for running unit tests. The 3rd command below copies its binary to a location in your path.

git clone git://github.com/ariya/phantomjs.git && cd phantomjs && git checkout 1.3
qmake -spec macx-g++ && make
cp bin/phantomjs /usr/local/bin

Cucumber.js

Cucumber needs the following support:

  1. Install node.js Macintosh installer

  2. Install npm:

    curl http://npmjs.org/install.sh | sh

  3. Now you can install Cucumber using npm:

Installation

Now, with the prep work finished, we can install the application.

Cloning

git clone git@github.com:oldfartdeveloper/yourjargon.git
cd yourjargon

This will cause rvm to ask you to confirm whether you want to use the .rvmrc file. Affirm positively as many times as you need to.

rake db:migrate

Running Rails Tests

rake

Starting Rails

rails s

Running the Web Application

Browse

Running the Browser Tests

Method 1

In your project home directory:

guard

Observe the test report. NOTE: this is set up so that everytime you save a javascript file, all the client tests are run again.

Method 2

Browse

This will show a Jasmine dashboard in which you can run tests and see results.

Miscellaneous

Credits

  • To the arailsdemo screencasts. They are excellent. Thank you!

About

A private glossary for your organization's jargon

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published