Linux Installation Guide

This guide assumes that you have already installed Ruby on rails. To get instructions on how to do that go through the installations project here

Set up Postgres

Skip this if you have already installed and setup a user for postgresql. First, we add the repository and then install postgresql and its dependencies:

$ sudo sh -c "echo 'deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main' > /etc/apt/sources.list.d/pgdg.list"
$ wget --quiet -O - http://apt.postgresql.org/pub/repos/apt/ACCC4CF8.asc | sudo apt-key add -
$ sudo apt-get update
$ sudo apt-get install postgresql-common
$ sudo apt-get install postgresql-9.3 libpq-dev

Next we need to create our role. Run the following:

$ sudo -u postgres createuser yourusername -s
$ sudo -i -u postgres psql
# Check that the user was created with:
postgres=# \du
# If you want to add a password to the role you created, run:
postgres=# \password yourusername
# Type \q to quit

Installing Gems and Migrating the Database

Now we need to pull down TOP's repository. To do this, go ahead and fork TOP repository. In your terminal run:

$ git clone https://github.com/YOUR_USERNAME_HERE/theodinproject.git
# Once git finishes cloning, cd into the project directory with
$ cd theodinproject

With all that taken care of, run bundle and everything should be green.

$ bundle install

Once bundle finishes, go to config/database.yml and write your username and password (only if you added a password) of postgresql for the development and the test database (leave the production alone). Next we create and migrate the database:

$ rake db:create
$ rake db:migrate

Set up the test database:

$ rake db:test:prepare

Get a Github API Token

You will need a Github API token to get all the tests to pass and for getting all the lesson content.

First create a application.yml with figaro, this is where you will store your Github API token.

$ bundle exec figaro install

Next go to personal access tokens in your Github user account settings and click the "generate new token" button. This will bring you to a new page. Give your token a description in the box provided, Something like "Odin " will do. Once that is done click the "generate token" button at the bottom of the page. The token highlighted in green is your new Github API token.

Copy your Github API token and go back to the config/application.yml file in your local Odin Project directory. Paste your API token in place of <your api token here> like the example below:

GITHUB_API_TOKEN: <your api token here>

Run the Tests

You can now run all the tests, they should all be green

To run the rspec unit tests:

$ rspec

To run the cucumber integration tests:

$ cucumber

Seeding the Database and Populating the Lesson content

Next you need to seed the database with the course and lesson data.

$ rails db:seed

We pull in the lesson content from the Odin curriculum repository on Github. We have created a rake task to do this easily.

$ rake curriculum:update_content

Running the app locally

You can now run the app on your local machine.

start the server $ rails server

Go to the app in your browser: http://localhost:3000

Setting up Github Omniauth (Optional)

We allow users to create an account on the site with Github OAuth. To get this feature working locally follow the instructions in this section.

Go to OAuth Applications in your Github user account settings and click the "register a new application" button.

Fill in the form fields with the following:

Application Name odin

Homepage URL http://localhost:3000

Application Description the odin project

Authorization callback URL http://localhost:3000/users/auth/github/callback

Click the "Resgister application" button. This will display your Client ID and Client Secret which is what you will use to get OAuth working on your local machine.

Go to config/application.yml in your local project directory for The Odin Project and fill in the following:

GITHUB_API_TOKEN: <your api token here>
GITHUB_APP_ID: <your client ID here>
GITHUB_SECRET: <your client secret here>

To test all this is working correctly, run the app locally and try to sign up with Github.

Need Help?

If you have any problems getting anything set up in this guide please let us know in our contributing gitter channel