Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josphat205/petfinder-phase4
https://github.com/josphat205/petfinder-phase4
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/josphat205/petfinder-phase4
- Owner: Josphat205
- Created: 2023-03-06T09:02:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T09:34:39.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T23:02:30.292Z (10 months ago)
- Language: JavaScript
- Size: 168 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PETFLIX
## Description
PETFLIX is a web application that helps people find and adopt pets in their local area. Users can search for pets by breed, age, and location, and can also save their favorite pets to view later.
This application aims to provide a convenient and straight forward way for a user to adopt a pet.
# Getting Started
In order for you to use the content on this repo ensure you have the following:
- A computer that runs on either of the following; (Windows 7, Linux, Ubuntu)
- nodejs 9.0+
## Features
### Display list of animals
click on the find a pet option on the navigation bar to display the list of available pets.
### Display animal details
click on a card on the animal list section to display the details of the pet
### Display list of Organizations.
click on the partner and organization option on the navigation bar to display the list of our partners.
### Display Organization details:
click on a card on the animal list section to display the details of the pet
### Search Organization & Animals:
This is a feature that enables the user to be able to search for Animals and Organization that the user prefers.
### Login & sign up
Click on the login button a dummy login it will redirect the user to a page with a dummy login form for the user to fill.
# Development installation
## Requirements
In order for you to use the content on this repo ensure you have the following:
- A computer that runs on either of the following; (Windows 7+, Linux, Mac OS).
- nodejs 9.0+
- Visual Studio Code.
- Live server extension.
### Alternative One
- Open a terminal / command line interface on your computer.
- Clone the repo by using the following to create a copy on your local machine:
git clone https://github.com/sainamercy/Petflix
- Change directory to the repo folder:
cd Petflix
- Open it in ``Visual Studio Code``
code .
### Alternative Two
- On the top right corner of this page there is a button labelled ``Fork``.
- Click on that button to fork the repo to your own account.
- Take on the process in ``Alternative One`` above.
- Remember to replace your username when cloning.
git clone https://github.com/sainamercy/Petflix
## Running the application
To run the application, you can use the following steps to run the app.
- Run `npm install` to install required dependencies.
npm install
- Run `npm run start` to open the application on your browser.
npm start
- Repeat the steps on the `Features` section above.
# Author
This project was contributed by :
- [Mercy Sania](https://github.com/sainamercy)
- [Trevor Febias](https://github.com/febiasm)
- [Simon Sirumba](https://github.com/Sirumba)
- [Shuaib Shaban](https://github.com/ShuaibShaban)
- [Casey Ochieng](https://github.com/CaseyOchieng)
# License
The project is licensed `ISC`
# Support
If you encounter any issues or have questions about using petflix, please contact us at support
https://petflix-nine.vercel.app/ We are happy to help.