Rideshare Rails

At a Glance

Pair, stage 2 project
Due EOD Friday, 10/5

Introduction & Objective

In this project you will build a website to model a small community Rideshare app in Rails

There will be two main pieces of functionality:

New passengers and drivers can sign up for the service and review their information
Passengers can request and rate trips, and drivers can see their aggregated statistics

This project is meant to be exploratory. Take time to try to dive into each piece of Rails (routes, controllers, models, views). This project is built so that you and your partner can create the waves yourself based on the dependencies of the requirements given.

Learning Goals

This project should demonstrate your ability to:

Create multiple related Active Record Models
Create models with validations and methods performing business logic
Craft effective RESTful routing
Work with a partner to create an attractive and functional Rails site
Practice Agile methodology
Work with a large amount of existing data in a rails app

Baseline

Initial Setup

Before you start writing any code:

High five your team
Discuss communication style/feedback style with your team
Review the requirements with your team
Follow any instructions given to the class regarding joining a specific Trello team/organization
Create a Trello board (in the correct team/org if applicable)
- Write and organize tasks/stories
- Prioritize tasks/stories
- Discuss who is interested in which tasks and any scheduling considerations
  - What things should be done together as pairs vs individually?
Create a diagram based on the data in the CSV files

Once the above is complete, this project:

Requires a shared repo with your partner as a collaborator
Requires you to create a Rails application which
- Conforms to Rails conventions on naming and inflection
- Is created by using rails new . you will create a new rails app inside of the fork folder instead of creating a new folder for your rails app
  - rails new . will ask if you want to overwrite the existing files README.md and db/seeds.rb. Answer n to both of these (keep the existing file)
- Uses Postgresql as its database. (This should already be configured correctly if you followed our Ada Install Fest for Rails)

Your team shall submit a pull request with a link to your Trello board once you are done with this initial setup. Your team must message your instructors and notify them that your board is ready for review.

Minimum Requirements

However far you and your partner get, the application should have, at a minimum, the following features:

Seeded data in your database from the original CSV files (see below)
Multiple related Active Record models
RESTful routing
Deployed application to Heroku
A "look and feel" that will make you and your partner happy!

Things to Keep in Mind

Use git relentlessly
Pair program on difficult problems and to share learning experiences
Don't leave deployment to the last second-- it will take longer than you anticipate
Business logic should be implemented in the model
You will probably need nested routes, but avoid routes that are more than 2 levels deep
Use semantic HTML
Make good use of partial views
Regarding validations:
- Validations are useful for making sure your database records are sane, and you should make use of them on this project
- It is easy to validate too much! If it's not a hard requirement for your app to function, it probably shouldn't be a validation
- If validations fail, let the user know why

Wireframes

We have provided some wireframes below; they are optional to use for executing layout. However, they should provide guidance for what views and information we instructors are expecting to see and interact with as we grade.

Seeding the Database

We have provided sample data for your site in the form of CSV files. These files are located in the directory db/seed_data/. We have also provided a seed script, db/seeds.rb, to load these files into your database.

db/seeds.rb assumes a few things about how your database is set up:

There are Driver, Passenger and Trip models
These models are related in a certain way
The field names of these models match the column names in the CSV files

This is the recommended way to configure this project, but not a hard requirement. If you've got a good reason to change the setup, feel free to edit db/seeds.rb accordingly.

Requirements

User Stories

This project has a lot of user stories, and it is likely you and your partner won't get to all of them. Here is our prioritized list of what's important for this project, based on this week's learning goals:

CRUD operations on models with relations
- Creating new trips
Model validations and reporting errors to the user
Basic structure of a complex Rails app
Deployment
Complex business logic
- Driver earning and average rating
Styling and design

Please use this list as you decide what to work on (or at the end of the week as you decide what features to cut).

Overall

From any page, I can click a menu entry to...
- View a list of all passengers
- View a list of all drivers
- Create a new passenger
- Create a new driver
From any form in the site, if processing the form submission fails, the user should be politely informed of what went wrong and how they can correct it

Working with Passengers

On the passenger list page I can click on a passenger to see that passenger's details
On the passenger's details page I can...
- See the total amount the passenger has been charged
- See a list of trips that passenger went on
  - Clicking on a trip from the list will take me to a detail page for that trip
- Click links to edit and delete that passenger
  - It is up to you and your pair on how to deal with "validations" surrounding deleting a passenger associated with a trip
- Add a new trip for this passenger
  - An available driver is selected automatically by the server
  - The trip starts with no rating
When adding a new passenger:
- The user must provide a name and phone number
- Don't worry about how the phone number is formatted

Working with Drivers

On the driver list page I can click on a driver to see that driver's details
On the driver's details page I can...
- See the driver's total earnings
  - The driver gets 80% of the trip cost after a fee of $1.65 is subtracted
- See the driver's average rating
- See a list of trips this driver has driven
  - Clicking on a trip from the list will take me to a detail page for that trip
- Click links to edit and delete that driver
  - It is up to you and your pair on how to deal with "validations" surrounding deleting a passenger associated with a trip
When creating a new driver:
- The user must provide a name and VIN
- Don't worry about how the VIN is formatted