Welcome to the FurEver Pet Adoption Website! This platform helps users find their perfectly matching pet(s) based on various criteria, offering a warm and welcoming experience.

• Team Information
• Project Overview
• Repository Contents
• Getting Started
• Acknowledgement

Team # 4 (Fantastic Four)

• Mayra Weidner - MYWeidner, mawe7753@colorado.edu
• Brittany Bilotti - brbi1248 - brbi1248@colorado.edu
• Mayumi Shimobe - Mayumi-GT - mash8545@colorado.edu
• Zack Cheng - zacktcheng - tsch3115@colorado.edu

Weekly Meetings: Fridays at 12 PM MST (30 min to 1 hr via Zoom) from Feb to May 2023.

Pet Adoption Website

To create a website that allows people to search for a pet that is best suited for them based on a variety of criteria. We hope to produce a working website that looks warm and welcoming with our newfound html skills that can pull the user's criteria from a sql database.

We have a passion for rescuing animals and a deep desire to connect those with the same values with an animal in need.

Risks:

• Only one team member has limited experience in HTML and SQL while the rest of the team has no experience
• The team does not have experience or knowledge of how to use Trello and very limited knowledge of Agile style meetings
• Difficulty scheduling due to time zone differences and no prior experience working with these team members
• Experience with command line is new

Mitigation Strategies:

• The team will use a search engine to research HTML and SQL that the team does not learn in class
• The team will practice with Trello and have each member take turns being the Scrum Master weekly so there is an equal opportunity to learn
• The team will keep an open line of communication and share scheduling conflicts
• The team will continue to practice command line and refer to the textbook

The team will use scrum to develop the website. Sprints will typically last 2 weeks and will consist of developing a small working portion of our website. What the team accomplishes in each sprint will depend on the material learned in class. The team will update Trello as the project progresses. The team will also take turns in the Scrum Master role to allow for equal learning opportunities.

We use Trello to track our project progress. Access our Trello board here.

This repository contains the following files and directories:

1. README
2. Weekly Status
3. PAGE TESTING
4. SQL TESTING
5. FINAL REPORT
6. Project presentation files from Milestone 5
7. Video of demo
8. Source code and testing
   • Below shows related repository structure and description.

   .
   ├── Furever.db
   ├── sql.py    
   ├── Furever.py
   ├── static
   │   ├── style.css
   │   ├── searchPage.js
   │   ├── (png files)
   │   └──  petImages 
   │── templates
   │   ├── HomePage.html
   |   ├── AboutUs.html
   │   ├── AdaptionForm.html
   │   ├── CatPage.html
   │   ├── DogPage.html
   │   ├── UserInformation.html
   │   └── ... (each dog and cat html files)
   ├── SQL_TESTING.md
   ├── Test_Queries.py
   ├── Test_Tables.py
   ├── setup.cmds <== cloned, original from CSPB3308 Lab 6 assignment
   ├── wsgi.py
   ├── prefix.py  <== cloned, original from Lab 6 assignment
   ├── requirements.txt
   ├── PetData
   │   └──  . . .
   ├── WebsiteDesign
   │   └──  . . .
   ├── Demo.mp4
   ├── FinalPresentation.pdf
   ├── WeeklyStatus
   │   └── . . . 
   └── README.md <== YOU ARE HERE
   
   

   Filename		Description
   Furever.db		SQLite database for the Furever project
   sql.py		Python file containing SQL-related functions
   Furever.py		Project code for Flask app with calls to prefix.py
   static		Directory with files needed for page display
   style.css		CSS file for styling the webpages
   searchPage.js		JavaScript file for search functionality on the page
   (png files)		Various PNG files used in the project
   petImages		Directory with images for dogs and cats
   templates		Directory with template HTML for rendering test pages
   HomePage.html		HTML file for home page
   AboutUs.html		HTML file for About Us page
   AdaptionForm.html		HTML file for Adoption Form page
   CatPage.html		HTML file for Cat Page
   DogPage.html		HTML file for Dog Page
   UserInformation.html		HTML file for User Information page
   SQL_TESTING.md		Markdown file for documenting SQL testing and results
   Test_Queries.py		Python file for testing SQL queries
   Test_Tables.py		Python file for testing SQL tables
   setup.cmds		Commands to setup a shell to run a Flask app
   wsgi.py		Commands to setup a shell to deploy at Render.com
   prefix.py		Flask app containing routines needed to run web service
   requirements.txt		Text file with required Python packages for the project for the public deployment
   PetData		Directory including the web scraping scripts and all aniamal source data from Petango for sql.py
   WebsiteDesign		Directory including design drafts from Milestone 2-4
   Demo.mp4		Product demo video (5 min)
   FinalPresentation.pdf		Final presentation slides for Milestone 5
   WeeklyStatus		Directory including weekly activity reports and minutes
   README.md		General information about this project

   
   
9. Documentation
   • This 'README.md' is the main documentation describing overview of this project.
   • 'Furever.py' is the main source code for the project. It uses Python as a programming language.
10. Link to Public Deployment (https://fureverpet.onrender.com/)
    • This website has following website to cover:
      1. '/' -- Homepage, the entry of Furever Pet
      2. '/aboutus' -- About the authors, mission statement, privacy policy, and the contact information
      3. '/adoptionform' -- provides a real adpotion form to simulate the adoption process
      4. '/contacts' -- adds new contacts to the "Contact" table in the database, update the User Information page
      5. '/cats' -- the search and display tool to retrieve cats with user-selected cat features
      6. '/dogs' -- the search and display tool to retrieve cats with user-selected dog features
      7. '/cat_*' -- individual cat pages
      8. '/dog_*' -- individual dog pages

Follow the instructions below to run Flask and host the PetRescue website locally.

git clone https://github.com/Fantastic4Project3308/PetRescue.git
cd PetRescue

python3 -m venv venv
. venv/bin/activate
pip install Flask
pip install psycopg2-binary
source ./setup.cmds

flask --app Furever.py run

Now, you can access our website by going to http://localhost:3308/ using your browser.

• We would like to express our gratitude to Prof. Knox for his invaluable support throughout this project. He consistently provided guidance and advice during his office hours and answered our questions on Piazza.
• In addition to the office hours and weekly assignment and learning materials, we also relied on the Google search engine to gain knowledge and find solutions to challenges we encountered along the way.
• Our team, the Fantastic Four, was truly awesome! The successful completion of this project was a result of the collective effort of each team member, who contributed their skills and dedication to create a remarkable pet adoption website.