nils_2_skills

Professional development skill tracking application written in Ruby on Rails

Versions:

• Ruby 2.1.5
• Rails 4.1.6
• PostgreSQL 9.3

Coding Standards:

• Please look in the documentation folder for more information on this topic.

Additional Tools:

• RVM to manage Ruby versions: https://rvm.io/
• RSpec-rails for testing: https://github.com/rspec/rspec-rails
• Rubocop for code analysis: https://github.com/bbatsov/rubocop
• Devise for user authentication: https://github.com/plataformatec/devise

Initial Setup:

1. Download and install VirtualBox: https://www.virtualbox.org/
2. Download and install Vagrant: https://www.vagrantup.com/
3. Create a project directory and clone this repository
4. From terminal enter the command "vagrant up" to create the vagrant box and run the install script
5. After the vagrant box is created, enter 'vagrant ssh' to access the vagrant box from the terminal
6. Enter 'cd /vagrant/nils_2_skills'
7. Run 'bundle install'
8. Run 'bundle exec rake db:migrate'
9. Download and install pgadmin: * Windows: http://www.postgresql.org/ftp/pgadmin3/release/v1.20.0/win32/ * Mac: http://www.postgresql.org/ftp/pgadmin3/release/v1.20.0/osx/
10. Open it, File -> Add Server
11. Fill in the Name, Host, Port, Username, and Password fields with the following info: * Name: nils_2_skills_development * Host: localhost * Port: 7001 * Username: developer * Password: developer

To start WEBrick and run the Rails app, use the alias 'runserver' from the command line.

Once the vagrant machine has been configured and WEBrick has been started, to view the application in your browser, use localhost:8888 followed by the page route once rails is running. For example: http://localhost:8888/home. The port number can be changed in the Vagrantfile.

The vagrant machine's root password is 'vagrant'.

Additional useful vagrant commands:

• To exit the vagrant terminal session type 'exit'.
• To shut down the vagrant vm enter 'vagrant halt' at the command line.
• If any changes are made to the boostrap.sh file (such as adding additional components to the installation process), execute 'vagrant provision'.
• Use 'vagrant destroy' to shut down and delete the vagrant vm.

NOTE FOR WINDOWS USERS: Sometimes on windows machines Vagrant will not successfully ssh into the box, due to the boot being unsuccessfull. This issue could be due to Hyper-V being enabled. Steps to resolve:

1. Go to control panel
2. Click on programs and features
3. Select "Turn Windows Features on or off"
4. Expand Hyper-V and uncheck all options.

For more information on vagrant: https://docs.vagrantup.com/v2/