AquaSense Documentation Index

Welcome to AquaSense! This document helps you navigate through all available documentation.

📚 Main Documentation

• DOCUMENTATION.md - Main project overview, setup instructions, and quick start guide
• CONTRIBUTING.md - Guidelines for contributing to the project
• LICENSE - Project license information

🔧 Component-Specific Documentation

Frontend (Mobile App)

• Frontend README
  • Flutter setup and installation
  • Project structure
  • Development guidelines
  • Troubleshooting

Backend (Server)

• Backend README
  • Node.js + Express setup
  • Database configuration
  • API endpoint documentation
  • Deployment guide

Raspberry Pi (Hardware Control)

• Raspberry Pi README
  • Hardware setup and wiring
  • GPIO pin configuration
  • Sensor calibration
  • MQTT integration

Object Tracking (Computer Vision)

• Object Tracking README
  • YOLOv8 and Deep SORT setup
  • Model training guide
  • Behavior analysis
  • Performance optimization

🚀 Quick Start Guide

For First-Time Setup

1. Prerequisites: Review the Prerequisites section in main README
2. Clone Repository: Follow Getting Started
3. Backend Setup: Follow Backend Setup Guide
4. Frontend Setup: Follow Frontend Setup Guide
5. Optional Components:
   • Object Tracking Setup
   • Raspberry Pi Setup

For Developers

1. Read: CONTRIBUTING.md for contribution guidelines
2. Setup: Development environment for your component
3. Code Style: Follow coding standards in CONTRIBUTING.md
4. Testing: Write tests for new features
5. Submit: Create pull request following PR guidelines

📖 Additional Resources

Project Website

• AquaSense Project Page

University Links

• Department of Computer Engineering
• Faculty of Engineering, University of Peradeniya

🆘 Getting Help

Documentation Issues

If you find issues or gaps in documentation:

1. Create an issue on GitHub
2. Specify which documentation file
3. Describe what's missing or unclear

Technical Support

Backend Issues: See Backend Troubleshooting

Frontend Issues: See Frontend Troubleshooting

Hardware Issues: See Raspberry Pi Troubleshooting

Object Tracking Issues: See Tracking Troubleshooting

Contact Team

For general questions:

• Create a GitHub issue
• Contact team members via emails in README.md

📋 Documentation Checklist

Before starting development, ensure you've read:

• Main README - Project overview
• Component-specific README for your work area
• CONTRIBUTING.md - Contribution guidelines
• LICENSE - License information

🔄 Documentation Updates

Documentation is continuously improved. If you:

• Find errors: Create an issue or pull request
• Add features: Update relevant documentation
• Improve clarity: Submit documentation improvements

Last Updated: January 2024

---

Note: This is an academic project. All documentation is maintained by the AquaSense team at the University of Peradeniya.