Skip to content

jebitok-dev/catalogue-of-pets

Repository files navigation

catalogue-of-Pets

Building a single page application(SPA) that has two pages i.e list of pets and details about specific pet i.e Name, Breed, Location, and Description. User can filter through the list by animal type, gender and size, and select favorite Pet to Adopt.

I acquired the petFinder API and [Front-end Master's pet API through npm and for the API Keys through the petFinder documentation where one can request for API key and secret key.

screenshot screenshot screenshot

Built With

  • petFinder API
  • Pet API by Front-End Masters
  • React
  • Redux Toolkit

Getting Started

Prerequisites

To get this project up and running locally, you must already have npm and nodejs plus the necessary packages installed on your computer

simple steps set up on your local machine

- $ git clone `$ git clone https://github.com/jebitok-dev/catalogue-of-pets`
- $ git checkout develop
- Run `cd catalogue-of-pets`
- ``$ npm install`` or ``$ yarn install``
- ``$ npm start``

Run Tests

Tests for modules written using Jest and React Testing Library

  • $ npm run test or $ yarn test

Author

👤 Sharon Jebitok

🤝 Contributing

Contributions, issues and feature requests are always welcome!

I love meeting other developers, especially ones that give me advice on how to improve my work.

Feel free to check the issues page.

How to Contribute

To get a local copy up and running follow these simple example steps.

- Fork the repository
- git clone https://github.com/your_username/catalogue-of-pets
- git checkout develop
- git checkout -b branch name
- git remote add upstream https://github.com/jebitok-dev/catalogue-of-pets
- git pull upstream develop
- git commit -m "commit message"
- git push -u origin HEAD

Show your support

Finally, if you've read this far, don't forget to give this repo a ⭐️. They're free . . . I think.

Acknowledgments

  • Microverse for project specifications.
  • Marc-Antoine Roy for his Recipe Design on Behance that will be using as inspiration for implementing the project.

About

Building single page web application that allows users to search a catalog of pets that they can adopt from a list and read more details of the chosen pet.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published