Skip to content

Latest commit

 

History

History
88 lines (49 loc) · 3.45 KB

README.md

File metadata and controls

88 lines (49 loc) · 3.45 KB
Raw

Pet's Love API 🐰

Pet's Love Contributing 🦊

  • Please take a look at the CONTRIBUTING.md file.

React + TypeScript + Vite + Tailwind + Vitest + React-testing-library

🐶 🐱 🦊 Pets Love 🐭 🐹 🐰

Welcome to Pets Love, an open-source project dedicated to the love and care of pets! Our mission is to create a positive impact in the world of animals by connecting shelters, veterinarians, volunteers, adopters, and brands in a unified platform.

Project Objectives

Empower with Technology: We help shelters, volunteers, and veterinarians embrace the digital world, facilitating pet management and care services.

Build a United Community: We forge an inclusive community where adopters, volunteers, veterinarians, and shelters connect and share knowledge, strengthening the support network in animal welfare.

Contribute to Science: We generate data sets and resources for data science and research, improving the health and well-being of pets through AI advancements.

Detailed Medical Records: Each pet has a comprehensive and accessible medical history to provide accurate information to veterinarians, shelters, and adopters.

Promote Responsible Adoption: We educate about responsible adoption and enable continuous tracking of a pet's well-being, fostering a culture of animal care.

Key Features

Comprehensive Pet Management: Shelters, veterinarians, and adopters can access medical, behavioral, and photo records for informed care.

Collaborative Interaction: We facilitate interaction between all stakeholders, from sharing updates to requesting assistance.

Data Set Generation: Contribute to science and technology by generating valuable data for research and advancements in animal welfare.

Pet QR Codes: We generate unique QR codes for each pet, enabling tracking even after adoption.

Join the Pets Love Community

Your contribution is vital to making the world a better place for pets. Join us and help provide love and care to those in need. Together, we significantly impact the lives of pets and the surrounding community. Click "Fork" and start your journey with Pets Love! 🌟🐕🐈

Visit our ![website] for more information and dive into the Pets Love experience.

😻 How to Help? 🐶

If you are a developer or UX designer who appreciates Pets Love, you can contribute by suggesting ideas or improvements through issue submissions.

For more information on how to contribute, please refer to the CONTRIBUTING.md file.

😻 Development Environment Setup 🐶

Make sure you have the following tools installed in your development environment:

  1. Node.js and npm: Ensure that Node.js is installed. You can download it from nodejs.org.

  2. Install Yarn: Yarn is a package manager that is commonly used in JavaScript development.

npm install --global yarn

Running the Project

Follow these steps to run the project locally:

  1. Clone this repository:
git clone https://github.com/alexrobaina/frontend_petsLove.git
  1. Navigate to the project directory:
cd frontend_petsLove
  1. Install project dependencies: Run the following command to install all project dependencies using Yarn. This project utilizes a yarn.lock file, which specifies precise versions of dependencies.
yarn
  1. Run project in development mode to start server in localhost:3000
npm run dev