Job Tracker project starter kit
Switch branches/tags
Nothing to show
Clone or download
Latest commit 8af998b Aug 13, 2018

README.md

Job Tracker

Learning Goals

  • Use migrations to create tables with different data types including indexed foreign keys
  • Update a routes file using appropriate syntax
  • Create controllers with methods for all CRUD functionality appropriately using RESTful routes
  • Use ActiveRecord in models to appropriately 1) manage relationships between resources, and 2) perform intermediate queries of a database
  • Use best practices in views, partials, and helpers to minimize the number of variables passed and duplication of code and follow SRP

Project Specs

You will be working with the existing code in this repository to modify a personal job tracking app. Imagine that your close friend has learned just enough Rails to be dangerous, and has started to create an app to track job opportunities they find interesting. They are planning to maintain this site themselves (i.e. they will be adding all companies and jobs, and don’t anticipate companies or other users posting/reviewing jobs). The application currently has the following functionality:

  • Jobs can be created and read.
  • Jobs have a title, description, a city, and level_of_interest.
  • Companies can be created, read, updated, and deleted.
  • Companies have a name.
  • A Job belongs_to a Company, and a Company has_many jobs.

Rubric

The rubric below describes additional functionality that you will need to add to this application, as well as code standards that will be expected.

Jobs

  • A user can create a job
  • A user can view a job
  • A user can update a job
  • A user can delete a job

Categories

  • The user can create a new Category by filling out a form. Each Category has a title (e.g. “Web Development”, “Education”, “Finance”).
  • When the user successfully creates a Category they are shown a page with the Category title.
  • When the user tries to create a Category that already exists, they are brought back to the page with the form to create a Category.
  • The user can view a list of all Categories on a single page, and each Category can be deleted from that page. There is also a link to “Edit” each Category, which takes the user to a form where they can update the Category.
  • When the user creates a new Job, they are required to select its Category from a drop down menu of existing categories. They also see a link to create a new Category.
  • When the user visits a page for a specific Category, they see a list of Jobs in that Category.

Job Comments

  • When the user visits the page for a specific Job, in addition to information about the job there is a form that allows them to enter a Comment for that Job (e.g. “Spoke to hiring manager, Jacob. Plan to follow up Monday.”).
  • Each comment has content (also created_at and updated_at).
  • When the user submits a new comment, they are redirected back to the page for that specific job and the comment appears on the page.
  • The user can leave multiple comments on a job and the most recent comments are shown above older comments (in reverse of the order in which they were created).

Company Contacts

  • When the user visits the page for a specific Company, in addition to information about the company there is a form that allows them to enter a Contact for that Company (e.g. “Penelope Santorini”, “Hiring Manager”, “penelope@wooo.com”).
  • Each Contact has a full name, position, email, and company (which relates to the company you’ve already created). It should be possible for a Company to have more than one Contact, but a Contact only works at one Company.
  • When the user submits a new contact, they are redirected back to the page for that specific company and the contact appears on the page.

Analysis

  • The user can visit /jobs?sort=location to view a list of the jobs sorted by city.
  • The user can visit /dashboard to see
    • A count of jobs by level_of_interest
    • The top three companies ranked by average level of interest along with their respective average level of interest.
    • A count of jobs by location with a link to visit a page with jobs only in that location. The url should be /jobs?location=Denver.
  • The user can visit /jobs?sort=interest to view a list of the jobs sorted by level_of_interest.

Databases

  • The database has appropriate tables and columns to create relationships between tables
  • Table and column names follow convention

Routes

  • Routes are defined for all functionality and not any additional functionality
  • All routes conform to RESTful conventions for resources
  • Routes to pages that are not specifically for resources stored in the database are not named in a way that an experienced developer would find surprising

Controllers

  • The developer has moved logic out of the controllers and into the models/POROs where appropriate.
  • The developer uses strong params in a private method
  • Instance variables being passed to views are appropriately named and limited in number

ActiveRecord

  • ActiveRecord methods are used in models to supply all appropriate functionality
  • Methods exist on the appropriate model
  • Developers are not referencing other classes or self in models unnecessarily
  • Ruby enumerables are not used where ActiveRecord methods could provide the necessary functionality
  • Developer can explain the ActiveRecord methods they used and the relationships between ActiveRecord models

Views

  • Logic has been removed from views and controllers to the full degree possible
  • Developer ha minimized the number of variables passed to the view
  • Developer can articulately explain their strategies for extracting this logic
  • Developer uses partials to reduce duplication of code in the view layer

User Experience/Usability

  • The application has been styled.
  • The application uses a balanced, considered color scheme.
  • The application implements a font (that is not the default font).
  • The application utilizes a nav bar.
  • The style shows evidence of intentional layout.
  • Space and text is balanced. White space is used to visually separate content.
  • The application is easily usable. The user can intuitively navigate between different portions of the application without manually entering the URL into the nav-bar or using the back button on their browser.

Testing

  • Project has a running test suite
  • Test suite includes robust feature tests
  • Test suite includes tests for validations
  • Test suite includes tests for methods that they have created on the models

Extensions:

Tags

  • The user is able to create new Tags from a form on the website.
  • Each tag has a Title (e.g. “interview scheduled”, “waiting to hear back”, “email sent”, “research complete”, etc.).
  • The user is able to view a list of Tags
  • The user is able to delete Tags from the list of Tags.
  • The list of tags also has a link to “Edit” each tag.
  • When a user visits the site for a specific Tag they see a list of all jobs with that Tag.

Evaluation Process

For the evaluation we'll work through the expectations above and look at the following criteria:

1. Feature Completeness

  • Exceeds Expectations: All features are correctly implemented along with two extensions
  • Meets Expectations: All features defined in the assignment are correctly implemented
  • Below Expectations: There are one or two features missing or incorrectly implemented

2. Views

  • Exceeds Expectations: Views show logical refactoring into layout(s), partials and helpers, with no logic present
  • Meets Expectations: Views make use of layout(s)
  • Below Expectations: Views show weak understanding of erb and 'HTML'. Logic is pervasive in views

3. Controller

  • Exceeds Expectations: Controller show significant effort to push logic down the stack, utilizing SRP & DRY
  • Meets Expectations: Controller is generally well organized with three or fewer methods needing refactoring
  • Below Expectations: There are four or more controller methods that should have been refactored

4. Models

  • Exceeds Expectations: Models show excellent organization, refactoring, and appropriate use of ActiveRecord features
  • Meets Expectations: Models show an effort to push logic down the stack, but need more internal refactoring
  • Below Expectations: Models are somewhat messy

5. ActiveRecord

  • Exceeds Expectations: Best choice ActiveRecord methods are used to solve each problem
  • Meets Expectations: ActiveRecord is utilized wherever it can be. There is no Ruby where there should be ActiveRecord
  • Below Expectations: Ruby is used to programmatically solve problems where ActiveRecord could be used

6. Testing

  • Exceeds Expectations: Project has a running test suite that covers all functionality, exercises the application at multiple levels, and covers edge cases
  • Meets Expectations: Project has a running test suite that tests all functionality, at multiple levels
  • Below Expectations: Project has sporadic use of tests

7. Usability

  • Exceeds Expectations: Project is highly usable and ready to deploy to customers
  • Meets Expectations: Project is usable, but needs more polish or navigation before it'd be customer-ready
  • Below Expectations: Project needs more attention to the User Experience, but works

8. Workflow

  • Exceeds Expectations: Excellent use of branches, pull requests, code review and a project management tool.
  • Meets Expectations: Good use of branches, pull requests, and a project-management tool.
  • Below Expectations: Sporadic use of branches, pull requests, and/or project-management tool.