Git Product home page Git Product logo

adopt-a-dog's Introduction

Adopt a Dog

Description

This project is a website designed to help users search for and get matched with shelter dogs. Users have the ability to filter dogs by breed or zipcode, and they can sort search results alphabetically by breed in ascending or descending order. Additionally, users can mark dogs as favorites and then generate a match from that list of favorites.

Installation

To run the site locally, follow these steps:

  1. Clone the repository:
git clone https://github.com/simk209/adopt-a-dog.git
  1. Navigate to the project directory:
cd adopt-a-dog
  1. Install project dependencies:
npm install

Usage

After installing dependencies, you can run the development server using:

npm run dev

Additional Scripts

  • npm run build: Builds the project for production after TypeScript compilation.
  • npm run lint: Lints the TypeScript and TypeScript React files in the project.
  • npm run preview: Previews the production build locally.

Future Considerations

While this app should meet basic requirements, it would greatly benefit from other UX-focused features, including:

  • Improved pagination with the ability to skip to a specific page number.
  • A more user-friendly filter that shows all filters applied and allows users to clear individual filters rather than resetting all filters.
  • The ability to reset favorites.
  • A display of the favorites list (Currently the list is stored as a state variable but not shown to the user. They can only see the match generated from the favorites list)
  • Improved accessibility

Additionally, it would benefit from comprehensive testing and improved responsiveness. Currently, the grid displaying dog objects changes depending on the screen size; however, filtering should also adapt, perhaps rendering a filtering icon that opens into a modal for smaller screens.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.