LookingFor

Description

LookingFor is a rails application that pulls developer job postings from the internet and uses them to answer the question "Hello, is it me you're looking for?"

Visit the App in Production

Documentation

We use basecamp to keep track of project information, wireframes, etc. Contact the team to be added to the project.

We track upcoming work in Github Issues.

Local Setup

Backend:

• Ruby
• PostgreSQL
• Puma Server

To install Ruby, check out RVM, rbenv or ruby-install.

PostgreSQL can be installed with Homebrew on Mac OS X: brew install postgresql If you're on a Linux system with apt-get then run: apt-get install postgresql postgresql-contrib

• You will need to make sure postgres is running and then run these commands in console:

  • bundle install - Install all dependencies
  • rake db:create - Create the database
  • rake db:migrate - Migrate the database
  • rake db:seed - Seed the database

• You can import a semi-current copy of the production database

  • Drop your local db: rake db:drop
  • Assuming you haven't changed any of the basic defaults - run heroku pg:pull DATABASE_URL lookingfor_development --app lookingforme
  • Find out more here

Run The Application

• Make sure you have bundled with: bundle install
• Start the server with: bundle exec rails s
• Then you can access the local server at localhost:3000

** Note: You must be able to run ruby 2.3.0 in order to view the app locally, as that is what the Gemfile currently specifies.

Travis CI

LookingFor has continuous integration enabled with the Travis CI gem. To get it running and use the command line client, run:

• gem install travis -v 1.8.2 --no-rdoc --no-ri

Make sure everything works by running:

• travis version

You can run travis help to see a list of all available query commands. Run travis help <query command> to get detailed information about a particular command.

More information can be found here or in the docs.

If you have issues running tests locally after setting up Travis CI, run the command rake db:test:prepare and that should solve the issue.

Testing

1. Run the test suite: bundle exec rspec

To run a single test suite, you can do so with:

  rspec path/to/the_spec.rb

To run a single test, you can do so by running the its first line:

  rspec path/to/the_spec.rb:15

Workflow

If you are a collaborator:

1. Clone this repo.
2. Create a new branch git checkout -b name-of-branch
3. Commit and push as usual on your branch.
4. When you're ready to submit a pull request, resolve any conflicts, push to your branch and submit the pull request as usual.

If you want to contribute, but are not a collaborator:

1. Fork this repo.
2. Add the upstream lookingfor repository as a new remote to your clone. git remote add upstream https://github.com/LookingForMe/lookingfor.git
3. Create a new branch git checkout -b name-of-branch
4. Commit and push as usual on your branch.
5. When you're ready to submit a pull request, rebase your branch onto the upstream master so that you can resolve any conflicts: git fetch upstream && git rebase upstream/master You may need to push with --force up to your branch after resolving conflicts.
6. When you've got everything solved, push up to your branch and send the pull request as usual.

Application Monitoring

Slack Error Reporting

For those collaborators from Turing, all production errors can be found in real time on the #lookingfor-errors channel in Slack.

General Monitoring

LookingFor uses New Relic. New Relic is also accessible in development at localhost:3000/newrelic

In order to access the account for LookingFor, you will need to ask one of the maintainers to invite you via e-mail. New Relic is already set up with Heroku, so this is all you need to access the production data.

If you want to run New Relic locally, you will also need the New Relic license key.

Once you have the license key and access to the account, you'll need to set up figaro:

1. Generate an application.yml file by typing in your terminal:

bundle exec figaro install

2. Add the following line to your application.yml file:

new_relic_license_key: <key provided>

3. Restart your server and the data will show up on New Relic within a few minutes.

More performance data can be generated in development, as documented in Basecamp. If you need access to this document, you can contact lookingfor@gmail.com.