PawSquad is a mobile application built using React Native, designed to offer pet rescue support services. This app aims to connect volunteers, pet owners, and shelters to facilitate the rescue and care of animals in need.
- User Authentication: Secure user login and registration functionality.
- Pet Listings: Browse through listings of pets available for adoption or rescue.
- Volunteer Services: Connect with volunteers willing to assist in pet rescue activities.
- Donation Support: Accept donations to support shelters and pet care initiatives.
- Messaging: In-app messaging to facilitate communication between users and shelters.
To run PawSquad locally, follow these steps:
-
Clone Repository:
git clone https://github.com/malinduwmp/PawSquad.git
-
Navigate to Project Directory:
cd PawSquad -
Install Dependencies:
npm install
or
yarn install
-
Set Up Environment Variables:
- Create a
.envfile in the root directory. - Define required environment variables (e.g., API keys, configurations).
- Create a
-
Run the Application:
- For iOS:
npx react-native run-ios
- For Android:
npx react-native run-android
- For iOS:
Contributions are welcome! If you have suggestions, feature requests, or bug reports, please submit an issue or a pull request.
- Fork the repository.
- Create your feature branch:
git checkout -b feature/my-new-feature
- Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin feature/my-new-feature
- Submit a pull request.
This project is licensed under the MIT License.
- This project utilizes React Native for mobile app development.
- Thanks to contributors and open source libraries used in this project.
Feel free to customize this README based on your project's specific details and requirements. Include sections like a project overview, specific setup instructions, usage examples, development guidelines, and licensing information. Good luck with your PawSquad application! 🐾