rubyforgood / shelter-assist Goto Github PK

Notes

• See mock here and click on Hoppy

User Story

As a foster
I want to find out more about this dog I am interested in
So that I can decide if its right for me to foster

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN I click anywhere on the baseball card for a certain dog

THEN I am taken to that dog’s page

Notes

• I am seeing two fields that ask the same question right now on https://shelterassist.herokuapp.com/
• Let's eliminate one
• See here for the mock

User Stories

As a potential foster
I want to tell the foster whether or not I'm home during the day
Because I want them to know about my foster situation

Acceptance Criteria

GIVEN I am looking at the foster application
WHEN the page loads 
THEN see a yes/no field with the label  "Are you or another adult home during the day?"

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here, though I expect it to take a few stories to get the page to look like this mock so follow the instructions on the Acceptance Criteria over the mock
• This feature is something the foster organizations are asking for so that there aren’t always the same dogs at the top of the page (i.e. if we sorted by dog name or something)

User Story

As the foster organizations
I want to randomize the dogs on the dogs page
So that all dogs get a fair shot at getting fostered

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN the page loads

THEN the dogs listed in a certain order

GIVEN I am on the “Dogs” page
AND the dogs were listed in certain order

WHEN I reload the page

THEN the dogs are listed in a different order

Check the package.json and upgrade any packages as appropriate. Also update to the latest version of node 18.x (provided Heroku and Github CI supports it).

Reference: https://nodejs.org/en/about/releases/

-Look into ways to implement magic link?
-What are the ways to have magic link and sign in for a person?

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here
• This is the most front end-y of the stories

User Story

As the potential foster
I want to be able to understand the dog page easily
So that I can pick one to foster

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN the page loads 
THEN I see each dog’s info grouped in a baseball card type layout
AND I see the dog’s picture at the top
AND I see the dog’s name as a heading

AND I see the breed, age, sex and weight all listed under
AND there are three baseball cards of dogs across

Notes

• When the person applies to be a foster, we want them to get some sort of communication from the organization, acknowledging that their application was received.
• Also include some sort of instructions on how to log in again

User Story

As a foster
I want to have some confirmation that I did indeed sign up
So that I'm not wondering whether I did right

Acceptance Criteria

GIVEN I am on the foster application page
AND I've filled out all the required fields
WHEN I click the submit button
THEN I get an email to the email address I provided on the form in the field "email"
AND the subject line is "thank you for applying"
AND the body says "Dear Potential Foster, Thank you for your submission. Someone from our team will reach out to discuss your application. Sincerely, [Organization Name]"
AND Organization name corresponds to which org the person signed up with

Notes

• The H1 on this page should be the foster's name
• See here for the mock

User Stories

As a volunteer
I want to immediately know if I'm on the right page
So that I can confirm I clicked the correct foster

Acceptance Criteria

GIVEN I was on the fosters page
WHEN I clicked on a foster's 
THEN this page loads
AND the foster's name is written at the top

• Install Rolify Ruby gem
• Get rid of admin and create roles: foster and volunteer
• default role will be foster

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here, though I expect it to take a few stories to get the page to look like this mock so follow the instructions on the Acceptance Criteria over the mock
• There’s another story to group the stat block together as a kind of baseball card, but this story for right now should only care about spitting the info on the page

User Story

As the potential foster
I want to know more about these dogs
So that I can pick one to foster

Acceptance Criteria

Breed

GIVEN I am on the “Dogs” page

WHEN the page loads and I’m looking at a certain dog

THEN I see the word “Breed:” as a label underneath the dog’s name

AND I see the dog’s breed listed below the label

Age

GIVEN I am on the “Dogs” page

WHEN the page loads and I’m looking at a certain dog

THEN I see the word “Age:” as a label underneath the dog’s name

AND I see the dog’s age listed below the label 

Sex

GIVEN I am on the “Dogs” page

WHEN the page loads and I’m looking at a certain dog

THEN I see the word “Sex:” as a label underneath the dog’s name

AND I see the dog’s sex listed below the label 

Weight

GIVEN I am on the “Dogs” page

WHEN the page loads and I’m looking at a certain dog

THEN I see the word “Weight:” as a label underneath the dog’s name

AND I see the dog’s weight listed below the label 

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here, though I expect it to take a few stories to get the page to look like this mock so follow the instructions on the Acceptance Criteria over the mock
• This page probably lives as /dogs ?

User Story

As a person who wants to foster a dog
I want to see all fosterable dogs
So that I can pick the one I want to foster

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN the page loads

THEN I see all the dogs that are currently “fosterable” in the system listed on this page
AND I see each dog’s name
AND I see each dog’s picture above their name

Notes

• This will be a textarea field to allow for more information that the potential foster can fill out
• Personally I think the backend field name (e.g. availabilityNotes) for this should be different than what shows up on the front end "Are there things we need to know about your schedule?"
• See here for the mock

User Stories

As a foster
I want to communicate more nuance about my schedule
So that the people placing dogs with me understand my schedule

Acceptance Criteria

GIVEN I am on the foster application
WHEN the page loads
THEN I see a text area field in the "Availability" section with the label "Are there things we need to know about your schedule?"

Notes

• See here for design, no need to worry about the cute graphics at the moment
• Some of this functionality exists here but this would allow the toggle between foster and volunteer

User Story

As a volunteer for The Little Black Dog
I want to log into the system
So that I can see the list of fosters

Acceptance Criteria

GIVEN I am on the login page

WHEN I toggle to "Volunteer"

THEN I see a field labeled "Email"
AND I see a field labeled "Password"
AND I see a button that says "Login"

h4. Notes

• See here for design, no need to worry about the cute graphics at the moment
• Some of this functionality exists here but this would allow the toggle between foster and volunteer

h4. User Story
As a volunteer for The Little Black Dog
I want to log into the system
So that I can see the list of fosters

h4. Acceptance Criteria
GIVEN I am on the login page
THEN I see a section that says "Login"
AND underneath that there's a toggle that says "Foster" and a toggle that says "Volunteer"
AND the default is to the "Foster" toggle being selected

Notes

• Is this story completely overkill? Maybe? You tell me.
• I want to make sure that when the user hits "submit" on the foster application, that information is actually saved to the database (I don't really care about the tables, I defer to engineers on that)
• See here for the mock

Acceptance Criteria

Submit button

GIVEN I am on the foster application page
WHEN the page loads
THEN I see a button at the bottom that says "Submit"

Saves to the database

GIVEN I am on the foster application page
WHEN I click the "Submit" button
THEN the information I filled out saves to the database 

Notes

• We don't yet have an H1, meaning it's the largest font on the page
• See here for the mock

User Stories

As a potential foster
I want to make sure I'm on the right page
Because I just landed here from somewhere else

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see the page title "Foster Application" at the top of the page

Notes

• Eventually we would want this app to work for different types of foster organizations i.e. cat foster groups too
• This field for the moment is going to be kinda silly but will eventually come in handy. It'll ask whether the foster is interested in fostering cats or dogs
• See here for the mock

User Stories

As a foster
I want to sign up to foster dogs
So that I get that I get a dog

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see a checkbox field with the label "Animal type" in the section "Pet Preferences"
AND the options are "Dog" and "Cat"
AND cat is disabled

Notes

• Just want to define what the different sections on this page are. Not much user value here, just making sure everything is in the right spot
• See here for the mock

User Stories

As a user
I want to understand how questions relate to each other
So that I am not confused

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see six sections:
Contact Info
Address
Additional Information: 
- Home Information
- Pet Preferences
- Availability

• Set up staging environment for QA testing

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here, though I expect it to take a few stories to get the page to look like this mock so follow the instructions on the Acceptance Criteria over the mock
• This page probably lives as /dogs ?

User Story

As a person who wants to foster a dog
I want to see all fosterable dogs
So that I can pick the one I want to foster

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN the page loads

THEN every dog's name listed that is in our system

Notes

• So I am going to make this story really big. Y'all tell me if it's too big. I am just going to throw displaying all of the baseball card information onto one story since it's mostly just displaying information instead of fields.
• This is what a volunteer would see once signed in when looking at a foster
• This is in this non-editable format to start because these are the pieces of information that probably won't change that much: people's address and facts about their home. But the volunteers will have other fields that are more in flux
• See here for the mock

User Stories

As a volunteer
I want to see an individual foster's information
So that I can see all their information in one place and get a sense of whether they'll

Acceptance Criteria

GIVEN I am a logged in volunteer 
AND I am on the Fosters page
WHEN I click the "edit" button (pencil icon)
THEN I am taken to that foster's edit page
AND I see the following fields labels with the foster's values underneath:
name
nickname
email address 
phone number
address
household (display the selected values)
home all day
home type
transportation
and preferred method of communication
AND that information is listed in a sidebar on the left

How does it work now?
Currently, it is not possible for a foster to log out of their account. After signing in, the "login" button is visible on the foster app.

How should it work?

• After logging in, a foster should be able to log out of their account using a "Log Out" button
• After logging in, the "Login" button should be hidden

Acceptance Criteria

• Verify that a foster can log out after signing in
• Verify that after signing in the login button is hidden

Notes

• A foster could be fostering multiple dogs, so we'd probably want a mutli-select dropdown like: https://harvesthq.github.io/chosen/
• See here for mock

User Story

As a volunteer
I want to assign this foster an animal
So that I can keep track of where the dogs are placed

Acceptance Criteria

GIVEN I am a volunteer 
AND I am on an individual foster's page

THEN I see a dropdown field that has the label "Animal" 
AND the options are all the dogs that don't have the status "adopted" yet
AND the options are listed in alphabetical order
AND I can select multiple dogs

Notes

• We'll probably iterate on this but for the first pass, we're going to have one "from" and one "to" availability field. This'll be important for the foster org to know when that foster is actually able to foster
• I love a date picker. Hopefully whatever front end framework we've chosen already has a datepicker and we don't need to reinvent the wheel
• See here for the mock
• Something like this maybe?

User Stories

As a foster
I want to let this organization know when I'm available
So that they can know when I can foster

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see a date field with the label "From" in the "Availability" section

Datepicker

GIVEN I am on the foster application page
WHEN I click into the "From" field 
THEN I see a popup with a small calendar and I can choose a date

• rename Foster Table to People for the Person model

Notes

• We want fosters to be able to specify what age dog they want. And they could check all if they wanted!
• See here for the mock

User Stories

As a potential foster
I want to specify what size dog I want
So that I get a dog I think I can handle

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see checkbox field with the label "Size preference" in the section "Pet Preferences"
AND I see four options:
less than 20 lbs
20-40 lbs
40-60 lbs
60+ lbs

How does it work now?
Currently, when a potential foster submits their Foster Application they are not taken to a different page. They see a confirmation message on the foster application page telling them their application has been submitted.

How should it work?
When a potential foster submits their Foster Application, they should be taken to a submission confirmation page that instructs them to check their email for magic link to sign in. (check w/ courtney to see if mock is ready)

If mock isn't ready, put text on page: "Success! Please check your email to sign in and view your profile."

Acceptance Criteria

• Verify that a potential foster is taken to a submission confirmation page after successfully submitting their foster application

Notes

• See here for mock
• This places an edit link for each row
• Use a font library, probably fontawesome: https://fontawesome.com/search?q=edit&s=solid%2Cbrands

User Story
As a volunteer
I want to edit a single foster
So that I can update their information because I just talked to them on the phone

Acceptance Criteria

See the icon
GIVEN I am on the fosters page THEN I see a column that says Edit at the top AND there is a pencil icon in each row

Click the icon
GIVEN I am on the fosters page WHEN I click the pencil icon THEN I am taken to that individual foster's edit page

Notes

• Some fosters might have a sex preference when it comes to their potential dog. Maybe this is because they have a male dog at home already and he might not get along with other male dogs. So we want them to have the option to set that or choose both if there is truly no preference
• See here for the mock

User Stories

As a foster
I want to only foster a certain dog sex
So that I don't foster a dog I can't handle for a particular reason

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see checkbox field with the label "Sex preference" in the section "Pet Preferences"
AND I see two options:
Male
Female

• Add Mailhog to dev environment to use for email when testing

Notes

• See here for design, no need to worry about the cute graphics at the moment
• We have some of this here: https://puppy-project-test.herokuapp.com/admin/people/sign_in just not the last part where they can login
• We don't have the "Fosters Dashboard" page built that is referenced in the criteria yet but I imagine it lives at something like /fosters. I'm thinking we can redirect the user there without anything living at that page yet.
• Please give me a test email and password I can use to confirm the acceptance criteria

User Story

As a volunteer for The Little Black Dog
I want to log into the system
So that I can see the list of fosters

Acceptance Criteria

GIVEN I am on the login page
WHEN I enter an email and password that match ones in the system
THEN I am routed to the volunteer view of the "Fosters" page
AND I see "Fosters" written across the top of the page (h1)

How does it work now?
Currently, the foster profile displays the foster's name
How should it work?

• Display all foster application data on the foster profile
• don't worry about styling

Acceptance Criteria?

• Verify that all foster application data shows up on the foster's profile

Notes

• I think everyone is VERY flexible about how this works. This could either be 5 fields (address line 1, address, line 2, city, state and zip) or this could be a Google Address verifier. My goal is truly whatever is easiest to build (aka fastest).
• I will write two different sets of acceptance criteria, it'll be like a little choose your own adventure
• See here for the mock, which is for the 5 fields option

User Story

As a foster
I want to enter in my address
So that the foster agency knows where I live

Acceptance Criteria Path A: 5 fields

Address Section

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a section that says "Address" 
AND that section has 5 fields

Street

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a text field with the label "Street" first in the address section

Apartment/Unit

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a text field with the label "Apartment/Unit" after "Street" in the address section

City

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a text field with the label "City" after "Apartment/Unit" in the address section

State

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a single select field with the label "State" after "Apartment/Unit" in the address section

State dropdown

GIVEN I am looking at the foster application page
WHEN I open the "State" field
THEN I see all 50 states as options I can choose

Zipcode

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a text field with the label "Zipcode" after "State" in the address section
AND I can only enter numbers into that field

Acceptance Criteria Path B: 1 Google address identifier field

Section

GIVEN I am looking at the foster application page
WHEN the page loads
THEN I see a section that says Address
AND there's only field in that section with the label "address"

Google verified address

GIVEN I am looking at the foster application page
WHEN I start typing in the field
THEN there are suggestions of addresses based on what I've typed in
AND I can select one

Notes

• So when a volunteer successfully logins, we're going to show them the "Fosters" page. This would be a list of fosters who have submitted a foster application
• Is this too big a story? I've never written a story for displaying a table before and I can't tell if I should break it into smaller chunks (aka each column is a different story). Let me know.
• See here for the mock
• Date available is the "availability from" date

User Stories

As a volunteer
I want to see a list of all the fosters who have applied
So that I can match a dog to a foster

Acceptance Criteria

GIVEN I have successfully logged in as a foster
WHEN the the "Fosters" page loads 
THEN I see a table of fosters (a person who has submitted a foster application)
AND the table displays name (first+last), date available, phone number, email
AND the table is zebra striped

Notes

• We'll probably iterate on this but for the first pass, we're going to have one "from" and one "to" availability field. This'll be important for the foster org to know when that foster is actually able to foster
• I love a date picker. Hopefully whatever front end framework we've chosen already has a datepicker and we don't need to reinvent the wheel
• See here for the mock
• Something like this maybe?

User Stories

As a foster
I want to let this organization know when I'm available
So that they can know when I can foster

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see a date field with the label "To" in the "Availability" section
AND this field is optional

Datepicker

GIVEN I am on the foster application page
WHEN I click into the "To" field 
THEN I see a popup with a small calendar and I can choose a date

I'am wondering if we want to utilize some linting library like https://github.com/rubocop/rubocop or https://github.com/testdouble/standard?

This can help keep our code consistent.

Notes

• Right now the field reads "Can you drive?" which feels a bit misleading. Maybe they can drive but that doesn't actually answer the question of whether they have a car

User Stories

As a potential foster
I want the foster organization to know whether or not I have access to a car
So that they can expect me to pick up a dog or need to bring a dog to me

Acceptance Criteria

See select field

GIVEN I am on the foster application page
WHEN the page loads
THEN there's a single select field with the label "Transportation"

Select field options (this one is already done)

GIVEN I am on the foster application page
WHEN I click open the single select field
THEN I see the options
Car
No car
Access to a car

Notes

• Volunteers should have the ability to edit foster information. Say a foster texts a volunteer and says "I have to go out of town on the 8th" the volunteer will want to update the fosters availability (we dream of self service but that's while away yet)
• See here for the mock

User Stories

As a volunteer
I want to update a foster's profile
So that we have the latest information on them

Acceptance Criteria

Edit button

GIVEN I am a logged in volunteer 
AND I am on the Fosters page
WHEN the page loads
THEN I see an "edit" button for each foster

Click the edit button

GIVEN I am a logged in volunteer 
AND I am on the Fosters page
WHEN I click the "edit" button
THEN I am taken to that foster's edit page
AND the foster's name is written at the top of the page (h1)

Notes

• We’re going to build the “dogs” page bit by bit
• Mock found here, though I expect it to take a few stories to get the page to look like this mock so follow the instructions on the Acceptance Criteria over the mock
• The mock has 12 but if you’re feeling like it should be more on a page, go for it, eventually we’ll have a three across layout

User Story

As a person who wants to foster a dog
I want to see all fosterable dogs broken up by page
So that the page doesn’t take for-freaking-ever to load

Acceptance Criteria

GIVEN I am on the “Dogs” page
WHEN the page loads
THEN I see only 12 dogs
AND I see pagination at the bottom

GIVEN I am on the “Dogs” page
WHEN I click on the “2” on the pagination the page loads
THEN the page reloads 
AND I see the next 12 dogs

Notes

• See here for mock
• This is a field on the foster object (person object?) that fosters themselves can't see but volunteers can

User Story

As a volunteer
I want to change a foster's status
Because I just talked to them on the phone and have approved them to foster

Acceptance Criteria

GIVEN I am a volunteer 
AND I am on an individual foster's page

THEN I see a dropdown field that has the label "Status" 
AND the options are: applied to foster, available, banned from fostering, currently fostering, permanently unavailable, temporary unavailable,
AND the options are listed in alphabetical order

Check the Gemfile and upgrade any packages as appropriate. Also update rails and ruby to the latest version.

• Set up Github action for running the test suite for a Pull Request

Notes

• Mock found here

User Story

As a person who wants to foster a dog
I want to see all fosterable dogs
So that I can pick the one I want to foster

Acceptance Criteria

GIVEN I am on the “Dogs” page

WHEN the page loads


THEN I see a header on the page that says “fosterable dogs”
AND I see the following text underneath the header: “Thinking about fostering? These adorable dogs from local rescues need someone to foster them while they await their furever home. Click on a dog below to see more information about each dog.”

Notes

• a "Volunteer" is someone who works for a foster based rescue. They most likely have a specific role within the organization but for now, suffice it to say a volunteer can see more information than the potential foster can. For example, they'd be able to see the foster applications.
• From an application perspective, I think it probably works to think of "volunteer" and "foster" or "potential foster" as two different roles
• No one asked me but I think we probably have a table for users and a table for person and those tables have a one to one relationship. It would make sense to me if what we were talking about in this story was a particular role for a user.
• See here for the mock

User Stories

As a volunteer
I want to login to FosterForce
So that I can see information relevant to the tasks I need to do

Acceptance Criteria

GIVEN I am on the login page
WHEN I enter an email and password that match ones in the system
THEN I am routed to the volunteer view of the "Fosters" page
AND I see Fosters written across the top of the page (h1)

• Style foster application with existing fields in the following sections:

• "Contact Info" fields: First Name, Last Name, Email, Phone Number

• "Address" fields: Street, Apt, City , State, Zip Code

• "Home Information" fields: Are you or another adult home during the day?, Tell us about your household, Transportation

• "Application" fields: Tell us things we might want to know about your home and your experience with pets

Notes

• Adding a single select so the foster can communicate what kind of home they have
• See here for the mock

User Stories

As a foster
I want to tell the foster agency what kind of house I have
So that I can make sure I get a dog that's right for my house

Acceptance Criteria

GIVEN I am looking at the foster application page
WHEN it loads
THEN I see a single select field with the label "Home type" 
AND it's in the "Home Information" section

GIVEN I am looking at the foster application page
WHEN I click on the select "Home type" field 
THEN I see the following options 
Apartment/Condo
Townhouse
House

How Does it Work Now?

• Currently, the home page for Shelter Assist is the sign up form (Foster application)

How Should it Work?

-Add new, basic home page with H1 "Welcome to Shelter Assist"
-Include 3 buttons for user:

1. Apply to Foster (takes user to Foster Application)
2. Foster Log In (if they're logged in, will take them to blank foster profile)
3. Volunteer Log In (takes user to Foster list)

Acceptance Criteria

• Verify that when a user navigates to the Shelter Assist home page, they see "Welcome to Shelter Assist" page title
• Verify that 3 buttons are visible on home page (Apply to Foster, Foster Log In, Volunteer Log in)
• Verify "Apply to foster" takes user to Foster Application
• Verify "Foster Log In" takes user to blank foster profile
• Verify "Volunteer Log in" takes user to Foster list

• Create new Rescue table
• Add Fields: Name, Email, Logo file name

Acceptance Criteria

• Verify that the Rescue table has been added to the DB with the following fields:
• Name
• Email
• Phone number
• Logo file name

Notes

• We want fosters to be able to specify what age dog they want. And they could check all if they wanted!
• See here for the mock

User Stories

As a potential foster
I want to specify what dog age I'm comfortable
So that I get a dog I think I can handle

Acceptance Criteria

GIVEN I am on the foster application page
WHEN the page loads
THEN I see checkbox field with the label "Sex preference" in the section "Pet Preferences"
AND I see four options:
Puppy (up to 3 months)
Young (3 months- 2 years)
Adult (2-5 years)
Senior (5+ years)

• Add Github action to run the test suite when opening a PR