Giter Club home page Giter Club logo

awesome-adoption's Introduction

Netlify Status License: MIT Node.js CI

PawternityHub

image image

A web application that helps users find pets to adopt around their area. It started out as a Hackathon project and then Open Source during Hacktoberfest All levels are welcome to contribute.

Contribution

Read Here Contribution

Tech Stack Used

  • React
  • Tailwind
  • Supabase
  • Daisy UI

Pet Finder Developer API Key

Register for an api key here PetFinder

Create an .env file in root folder

In the .env file put

REACT_APP_PETFINDER_KEY = APIKEYhere&client_secret=secretkeyhere

Restart the app

Where the key is being used

grant_type=client_credentials&client_id=${process.env.REACT_APP_PETFINDER_KEY}

This project was bootstrapped with Create React App.

Supabase

Join My Discord for the Supabase keys, which need to be in .env

Setup

yarn

yarn prepare

yarn start

test

yarn test

Errors Fix

If you are getting this InvalidTokenError: Invalid token specified: Cannot read properties of undefined (reading 'replace')

go to dev tools-> application storage-> local storage

Delete the token

Available Scripts

Installing Yarn

npm install --global yarn

After Installing Yarn

yarn install

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn format

Formats the code.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. ""

Instructions on installing yarn and differences between yarn and using npm

Yarn

Yarn is a package manager for your code. It allows you to use and share (e.g. JavaScript) code with other developers from around the world. Yarn does this quickly, securely, and reliably so you don’t ever have to worry. Yarn allows you to use other developers’ solutions to different problems, making it easier for you to develop your software. If you have problems, you can report issues or contribute back, and when the problem is fixed, you can use Yarn to keep it all up to date. Code is shared through something called a package (sometimes referred to as a module). A package contains all the code being shared as well as a package.json file which describes the package Both NPM and yarn are package Managers that help in Managing Project Dependencies

Npm

npm is the world's largest software registry. Open source developers from every continent use npm to share and borrow packages, and many organisations use npm to manage private development as well. npm consists of three distinct components:

  • the website
  • the Command Line Interface (CLI)
  • the registry Use the website to discover packages, set up profiles, and manage other aspects of your npm experience. For example, you can set up organisations to manage access to public or private packages. The CLI runs from a terminal, and is how most developers interact with npm. The registry is a large public database of JavaScript software and the meta-information surrounding it.

Setting up prettier in vscode and auto format on save

Ways to Install Prettier as a VS Code Extension:

  1. In vscode, search up prettier in extensions and install
  2. To set up auto format on save, go to settings
  3. search format save and check it
  4. be sure to select prettier as your formatter

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

awesome-adoption's People

Contributors

akshay399 avatar bcastillo32 avatar danyalasif avatar dependabot[bot] avatar dhillonks avatar drew5494 avatar emraftis avatar fallen-ecstasy avatar foobar98 avatar github-actions[bot] avatar kokoaono avatar kprime21 avatar masayashinoda avatar maz12211 avatar merikettapearl212 avatar mljbrackett avatar nemynigam avatar omthakare16 avatar prajaktasathe avatar rajdama avatar redxzeta avatar rupak2001 avatar salihsenturk avatar shakyaprasen avatar smabbett avatar tiagoheras avatar trujillo9616 avatar waishnav avatar web2feel avatar youssefmahmod avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

awesome-adoption's Issues

yarn Compile error

Was trying to run the app in development mode so I could make changes. Then this compile error came up after doing yarn start
It can't be dismissed at the bottom it says so I can't make yarn ignore/dismiss this.

Add more charities to Donate page

If you know any more charities, feel free to add them to charities.json. RIght now it is three.

Also taking suggestions to improve the site or add new features to the donate page

mouse hover over image shows another picture

In PetType.js, mouse hover over would transition to another image of the pet and then after returns to the original pet img.

Might also need to check if pet has more than one or none

Storing the api key

Maybe store it in localstorage or something so there won't be in constant requests in App.js?

Unless someone has a better solution

 const [token, setToken] = useState("");
  useEffect(() => {
    axios
      .post(
        "https://api.petfinder.com/v2/oauth2/token",
        `grant_type=client_credentials&client_id=${process.env.REACT_APP_PETFINDER_KEY}`
      )
      .then((response) => {
        setToken(response.data.access_token);
      })
      .catch((error) => {
        console.log(error);
      });
  }, []);

Optmize the Resource page

Optimize the Resource page for best practices. Some of the code has <br> tags or uses <b> tags. Feel free to update the css and Resources.js

    <br />
        <br />
        <b>
          Pawternity Hub wants to help you stay safe and help you find a friend
          that can keep you company during the pandemic
          <br /> Check out the links below for more information about adoption
          during Covid-19
        </b>
        <br />

Adding Pagination of the list of pets

Currently displays one page of pets

using this link https://api.petfinder.com/v2/animals?type=${type}&location=${zipCode}&limit=10&page=1, in PetType.js

implement a next and previous button in PetType.js to view the next page of pets

Adding border to contributors

In the contributors page, some of them have a white background blending it in.

Add a black border around it or variety of colors

New Logo for the site

Anyone want to create a new logo for the site?

Replace PawHub in the Navigation bar with the logo

Add the logo to the site

Migrate to Bootstrap 5

Migrate to Bootstrap 5 docs

    "react-bootstrap": "^1.6.0",
    "bootstrap": "^4.5.3",
    "bootswatch": "^4.5.2",

these need updating

There might be some breaking changes and may need to update the code

Revamp the home page

Home page seems lacking. Maybe add featured pets of the week or random pets.

Open to other features and feedback.

Feel free to remove the image and css if necessary

Convert Inline Style to CSS

There are some files that contain inline style.
Would be better to organize it in css files.
The css file could be in the same folder where it is used unless there's a better suggestion.
May have to override the css from bootstrap

<Card style={{ width: "100%", paddingTop: 10 }}>

Revamp Landing Page

Revamping the home page

Two sections
section1 New background images of pets could be from free stock photo
Title and Adopt a buddy today could placed where you think looks best

section 2
would have the featured pet cards
implement a transition fade in
button to get another featured pets cards with another transition

Add A resource page

Info for adopting pets

Info about covid

Helpful links and styling the page if u can

Validation for zipcode

image

make sure the zipcode is valid
and display an error when the zip code is invalid
US zipcode for now 5 digits

Featured Pets in Home Page

image

Featured Pets of the Day/Week either in a Card or Gallery

Clicking on the image takes u to the pet and hovering shows more images

Feel free to remove the animation in home.css

Any more ideas are welcome

Add title and onHover effect on Pets.js

There isn't a title for each picture.

Add an onhover effect over each image which shows the text for the type of pet
add onhover effect color over it something like this below. Feel free to experiment and variety of colors

image

Create a Login and Register Page

Create a page for user login and user register page could include email, username, password.

If possible, add validation checks.

For the navigation bar, implement a drop down from react-bootstrap, and then add links to login and register. The title could be Profile

Planning to implement supabase to handle the data.

fix github button

due to the migration to using bootstrap 5, there were variable changes

in the about page, the github button needs fixing and would need to be change to use var(--bs-primary) in the css

Backend Implementation

Wondering what kind of backend should be implemented?

Purpose of it would be for users to sign up, login and share stories or favorite pets

Thinking of using Supabase, Express or Nest.

Any suggestions or ideas would be appreciated

name of pet gets too long

Some pet names get too long and extend the card height.
Maybe set a max number of characters for the pet name.
Open to suggestions.
image

Align menu to right

If we divide navbar with "logo" to left and menu to right I believe that is a good improvement.

Add more orgs in donation page

Add some organizations or places to donate in charities.json

Feel free to create a pull request since there could be a lot of organizations or places

Add a 404 page

Add a 404 page when a user tries to enter a page that does not exist

and add an image of pets or something

put a button that helps users redirect to the home page, button redirect to /about , and button for /pets

Add Testing?

I am not really familiar with testing.

If someone is up to implement it, go ahead

Switching Pet Type page

Clicking on a different pet type doesnt take u to the page and the link changes to http://localhost:3000/pets/pets/horse

Update Readme

Update readme so beginners or newcomers clone project, set up a working environment, tips for new contributors, navigating through the project, links to bootstrap and react-bootstrap, mention each page has their own folder and anything you can think of

Add About Page

Create an About page and put a link in the nav bar
Just put in lorem ipsum filler text and a filler image.

Updating PetInfo.js

update pet state to const [pet, setPet] = useState({});

instead of ternary operator return pet ? ... : .. line 37
use if
if pet is empty return the <Spinner />
if not return the petInfo <div className="petInfo">...

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.