About the project:

PetMe-Prod

"Bringing Hearts and Paws Together"

Don't forget to join our official Discord Channel for discussions and updates.

🌕 Inspiration for the Project:

It has been estimated that more than one million adoptable dogs and cats are euthanized in the United States each year. This happens for the reason that there are too many pets that are enrolled into shelters and only a few people consider adoption when they look out for a pet.

When our team heard about the animals that were in danger each year, it became a goal for us to help these speechless beings somehow. After brainstorming for a long time we came up with the idea of PetMe-Prod. We believe in the policy of saving animals and thus saving lives. Every life matters and we wish to be the part of the change that is making the same possible.

🚀 Techstack

• Admin : NextJS, Shad/cn
• Frontend : ReactJS, TailwindCss
• Backend: NodeJS, ExpressJS
• DB: Postgres
• Devops: Docker, TurboRepo

👨‍💻 Contributing

💥 How to contribute

• Take a look at the existing Issues or create a new issue!
• Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
• Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
• Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
• DON'T CREATE PRs WITHOUT CREATING ISSUE AND GETTING ASSIGNED
• For more details, refer to CONTRIBUTING.md file.

⭐ Local Setup

git clone <repo>
cd PetMe-Prod
npm install
npm run dev

ENV VARIABLE

• under app/PetMe-Backend , insert your postgres URL

  DATABASE_URL="postgresql://user:paswd@localhost:5432/PetMe"

🗒️ Documentation

API Docs For backend and frontend developers to follow (would keep updating it as we change the code)

https://worried-puma-2ec.notion.site/API-Docs-for-Pet-Me-Backend-4ca061475b2a4d5a8526ebf3a23bd98d

😎 Project Maintainers

Chaitanya

Pratham

Uday

Akshita Gupta

License 🛡️

PetMe is licensed under the MIT License - see the LICENSE file for details.

Socials