CS732 project - Team Expected Exceptions

Screenshots:

Team members:

• Chris Dai (cdai874@aucklanduni.ac.nz)
• Suzi Ni (sni026@aucklanduni.ac.nz)
• Andres Amaya Prada (aama064@aucklanduni.ac.nz)
• Alesson Abao (aaba474@aucklanduni.ac.nz)
• Lujia Yang (lyan805@aucklanduni.ac.nz)

Previous team members:

• Harrison Carnahan (hcar156@aucklanduni.ac.nz)

Spawtify 🐾

A real-time mapping platform transforming residents into urban ecologists, helping to understand and protect Auckland's unique urban wildlife. With nearly 40% of New Zealand households owning cats, and many roaming outdoors, Spawtify provides a comprehensive solution for tracking and understanding urban animal populations.

Overview

Spawtify is a community-powered platform that addresses three essential needs:

• Linking pets with their owners
• Fostering appreciation for local creatures
• Tracking and understanding urban animals

Features

For Pet Owners

• Map-based visualization of pet roaming area
• Community-powered lost pet spotting
• Photo sharing and documentation

For Community Members

• Interactive community bio-map
• Wildlife sighting documentation
• Neighborhood engagement through animal tracking
• Conservation awareness

Why Spawtify?

Convenience for Pet Owners

• Traditional methods (posters, social media) are fragmented
• Spawtify provides a unified, map-based solution
• Real-time tracking and visualization
• Easy-to-use interface for locating pets

Community Building

• Uses animals as an emotional medium for community interaction
• Creates a shared "community bio-map"
• Encourages neighborhood cooperation
• Promotes awareness of local wildlife

Technology Stack

Frontend

• React.js
• React-Leaflet for map components
• Tailwind CSS for styling

Backend

• Node.js
• Express.js
• MongoDB
• AWS S3 for image storage

Development Tools

• GitHub for version control
• GitHub Kanban for project management
• GitHub Issues for task tracking

Development Workflow

Branch Management

• Branches mirror GitHub task titles
• Pull requests require at least two approvals
• Semantic commit messages are required

Code Review Process

1. Create a feature branch
2. Implement changes
3. Submit pull request
4. Receive team reviews
5. Address feedback
6. Merge after approval

Getting Started

Prerequisites

• Node.js (v14 or higher)
• MongoDB

Installation

1. Clone the repository:

git clone https://github.com/your-username/spawtify.git

2. Install frontend dependencies:

cd frontend
npm install

3. Install backend dependencies:

cd ../backend
npm install

4. Set up environment variables:

# Frontend (.env)
VITE_SPAWTIFY_API_URL=http://localhost:3000

# Backend (.env)
Paste the information provided inside the privately submitted .env file

```bash
# Backend
cd backend
npm run dev

# Frontend
cd frontend
npm run dev

Testing credentials

Please use the following login credentials as a reference when testing.

Username	Password
testing	testing123

Contributing

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

Live App

Our project is deployed and publicly accessible at https://spawtify.onrender.com

License

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

Acknowledgments

• Animals in New Zealand
• Leaflet for mapping capabilities
• AWS for cloud storage solutions