Skip to content

abryan1811/cat-union

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CatsUnion


Table of Contents


  1. UX
  2. Features
  3. Technologies Used
  4. Testing
  5. Deployment
  6. Credits

UX


User Stories

  • As a user, I want to be able to adopt a Cat or a Kitten to care for.

  • As a user, I want to be able to donate to the charity so I can give my support.

  • As a user, I want to be able to sponsor a Cat to a Kitten so I can give support to a specific cat the charity cares for.

  • As a user, I want some support in how to best take care of Cats and Kittens.

  • As a user, I want to be able to contact the charity.

  • As a user, I want the website to run on different screen sizes.

  • As a user, I want to be able to apply to volunteer my time to help the charity.

  • As a user, I want to be able to raise funds in other ways so I can give support to the charity.

Project Viability

Feature Importance Viability
A Information about the charity 5 5
B Generate money for the charity 5 4
C Adoption info 3 4
D Responsive application form 5 4
E Location and contact info 3 4
F Cat care support 2 4
Total 23 25

Responsive

Am I Responsive? was used to test how responsive the website is on different devices.

Frameworks Used

Typography

The following webpage was useful in order to decide which font style to select. A display type was chosen due to its friendly accessible approach, and Sans-Serif as the fallback font.

1 Google Font was used throughout this website:

Colors

The following website was useful in order to decide which colours I used for my website.

  • Navbar
  • Buttons
  • Footer
  • Donate-Panel

Icons

Font Awesome 5.13.1 The following 4 Font Awesome icons were used.

  • map - used in the Contact Us modal
  • phone - used in the Contact Us modal
  • mail - used in the Contact Us modal
  • copyright - used in the footer

Wireframes

Logo

  • GIMP was used to create the logo by editing this image. The website font from Google Fonts was then added to GIMP and then inserted underneath the image to create the logo.
Back to top

Features


Existing Features

  • Adopt

    • Allows user to see the selection of cats available for adoption and follow a link to contact the charity directly and to find out where to find them.
  • Donate

    • Allows user to give money to the charity by pressing a button and going to checkout through PayPal. (dummy)
  • Sponsor

    • Allows user to select a cat to sponsor by pressing a button and going to checkout through PayPal. (dummy)
  • Videos

    • Allows users to watch appropriate videos on the page which give support with cat care.
  • Navbar

    • Navbars are used throughout which work effectively to link between all pages. Logo also leads back to Home. On smaller screens the links become a toggle button.
  • Footer

    • Footers are used throughout which allow users to use links to appropriate Facebook, Twitter and Instagram page. Users can also follow links to important anchors of Donate, Adopt and Sponsor. There is also a button for users to click which links to a Bootstrap modal with a map and contact details.
  • Volunteer Form

    • Allows users to fill in a form to volunteer. The form includes a file upload button so users can attach their covering letters.

Features to Implement

  • Support-Us buttons checkout

    • The purchase page of Donate / Sponser will eventually link to a PayPal purchase page. Currently links to a demo.
Back to top

Technologies Used


  • HTML

    • This project uses HTML to create the main functions of the website.
  • CSS

    • This project uses CSS to override the Bootstrap elements and apply the determined styling.
Back to top

Testing


Validators

  • HTML

  • CSS

    • W3C CSS Validator "Congratulations! No Error Found. This document validates as CSS level 3 + SVG !"

Chrome's DevTools Audit report

Testing Methods

For information on the testing, follow the link to the document here

Back to top

Deployment


*The CatsUnion repository was developed using GitHub Workspaces, and all commits were pushed to GitHub using Git.

*Commits were pushed every time important sections were completed in order to create useful ongoing checkpoints.

Local Deployment

  • Local Deployment not required

Remote Deployment

*In order to deploy the website, the following was actioned:

  1. Navigate to GitHub repository:
  2. Open the cat-union repository:
  3. Click on the Settings tab at the top:
  4. Scroll down to the GitHub Pages section.
  5. The first drop-down field should be Source with None pre-selected.
  6. Select master branch from the list.
  7. The page should refresh.
  8. Scroll down to the GitHub Pages section.
  9. There will now be a deployed link:
Back to top

Credits


Content

  • All written content was my own.

Media

Acknowledgements

Inspiration for this project was drawn from Dogs Trust

Back to top

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published