Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Find'a Floof : WIP

Wanted to make a fun way to search for adoptable pets that was fun to use on mobile while also nice on desktop. Uses the petfinder API, React and Next.js. Currently a work in progress.
Explore the docs »

View Site · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

Idea

Wanted to create a fun and easy way to browse adoptable pets. Allows filtering based on criteria specified by the user, saving of pets to a favorites for later viewing, swiping to add or pass on animals with correlating animations.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

There are a few important steps in getting this project setup. Follow the instructions

Installation

  1. Clone the repo

    git clone https://github.com/drewole/findafloof.git
  2. Install NPM packages

    npm install

    or

    yarn start
  1. Run the Application

    npm dev

    or

    yarn dev
  2. View the application: View in Browser

Usage

Use at your own risk. Still in development and riddled with bugs.

For more examples, please refer to the Documentation

Roadmap

Planned Features:

  • Only fetching more animals when there are only a few left instead on every index load
  • Animations to hint at the swipe direction
  • Sharing system for app and individual animals

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact the Contributors

Drew Olsen - @drewole

Project Link: https://github.com/drewole/findafloof

Acknowledgements

About

Fun app to browse adoptable pets using the Petfinder API. Currently a WIP

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages