search

malaysiamidwestgames / sambal

Web platform for Midwest Games
6 stars 0 forks source link

readme

Sambal

Welcome to our Sambal project. We have high ambitions, but first, we need to setup our computers :)

Installation instructions

  1. Install Ruby and Rails

    We are using Ruby 2.2.0 and Rails 4.2.0. Install the same version (it should be the latest one).

    Unfortunately, it is a bit hard to develop Rails in Windows (buy a Mac people), but you can try RailsInstaller or Nitrous.io (virtual machine).

  2. Install Nodejs

    Test installation by typing node -v in terminal/command line. It should output the version.

  3. Install Git

    For windows users, when given the option git Bash only, windows command prompt, or linux tools on command prompt, choose windows command prompt.

    Test installlation by typing git -v in terminal/command line. It should output the version.

  4. Install compass

     gem install compass

  5. Install grunt and bower

     npm install -g grunt-cli
 npm install -g bower

  6. Add your ssh keys to Github

    For Windows users, you will have Git Bash after you install Git. I highly recommend using Git Bash and not the Windows command line

  7. Clone the repo using ssh

    git clone git@github.com:vanblaze/sambal.git

  8. Install app dependencies

    Inside the samabal folder, run:

    bundle install

    then cd to the ng-app folder and run:

    npm install && bower install

You should be all set! Open two terminal tabs, cd into sambal directory and run rails s on one tab. cd into ng-app directory and run grunt serve. Now you have the app running on your machine!

Build

  1. cd to sambal directory, using terminal/command prompt/cygwin:

  2. Install gems:

     bundle install

  3. If you ran "db:migrate" before, reset database. Do so by:

     rake db:reset

  4. Migrate your model to your database. Do so by:

     rake db:migrate

  5. Populating university database: 

     rake csv_model_import[universities.csv,University]

  6. Start rails local back-end server:

     rails s

  7. In a browser, open (http://localhost:3000/)

  8. On a new terminal tab/window, cd into ng-app directory

  9. Install all front-end dependencies:

     npm install && bower install

  10. Start local front-end server:

     grunt serve

  11. In a browser, open http://localhost:9000/app/