Ilmomasiina 3.0

Backend development

Requirements

• Ruby 2.1.5
• Bundler
• JS runtime (e.g. node.js, therubyracer, JScript)
• MySQL

Installing dependencies on OS X

Programs to be installed:

• Homebrew
• Ruby 2.1.5
• Bundler
• MySQL

First you must install Homebrew and then make sure your ruby version is correct.

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
brew install rbenv
brew install ruby-build
brew install mysql

The MySQL install command (brew install mysql) will output you information on how to setup MySQL to launch on login. Follow the instructions on the screen.

Installing correct ruby version

If you are using bash as your shell (default on OS X), then run the following commands:

echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
. ~/.bash_profile

If you are using zsh and oh-my-zsh in your shell, add rbenv to your list of plugins in ~/.zshrc file. rbenv will be loaded automatically.

Now ruby -v should output the correct version when you are at the root of this repository. If not, please double-check the instructions above and file an issue and attach the steps you tried to do to make it work. If you happened to have brew already installed, please check that brew doctor error messages related to PATH are fixed.

Last steps on installing dependencies

Now we need to install some basic gems to get us up and running:

gem install bundler
rbenv rehash

If you want more extra neatness, check out Other services in use (scroll down this README).

Installing requirements on Windows

1. Buy OS X
2. Follow instructions on for OS X

Setup

git clone [email protected]:atk-partio/ilmomasiina.git
cd ilmomasiina
bundle install
bundle exec rake db:setup

Running

rails server

Other services in use

We use gems which help us develop stuff faster. They are listed below.

gem install travis
gem install heroku
gem install git-up
gem install zeus

For git-up gem, you might want to stop it automatically rebasing your current branch in order to not wreak havoc when branches have diverged.

git config --global git-up.rebase.auto false

Zeus is a program to make your rails app boot under a second. You can replace basic rails commands with the following ones to gain more speed.

zeus start
zeus server

Frontend development

Technologies used in the frontend:

• Reflux, React
• Webpack
• ES6

Requirements

Installing correct NodeJS version

Install Node Version Manager by following the installation instructions. Then run the following commands:

nvm install
nvm use

Nvm reads the NodeJS version from .nvmrc, installs the correct version, and uses that version when calling node or npm.

Installing NPM dependencies

npm install

Running the build script

npm run watch

Runs Webpack build.

Running the hot-update build script

You need to run rails server with WEBPACK_DEV_SERVER env set:

WEBPACK_DEV_SERVER='http://localhost:8080' rails s
npm run hot

Now your changes to JSX files are automagically hot-updated in the browser. Cool!

Adding new NPM modules

npm install package_name --save
npm shrinkwrap

Remember to run Shrinkwrap to make sure that everyone has exactly the same versions of the dependencies!

Use mocked data instead of API

Add ?mockapi to your url.