Documentation - WSU-4110/FindMySpot GitHub Wiki

The FindMySpot project includes two primary documentation files: README.md and INSTALLATION.md, which together provide a complete overview of the system’s purpose, functionality, contributors, and setup process.

1. README Documentation

The README.md serves as the main project overview and clearly communicates the system’s purpose and functionality.

It includes:

  • A detailed description of FindMySpot as an AI-powered parking management system that uses license plate recognition to locate vehicles
  • A comprehensive overview of system features, including:
    • Automatic license plate detection
    • Vehicle search and tracking
    • Manual check-in functionality
    • Notifications and parking history
    • Real-time parking and occupancy features
  • A clear explanation of the system architecture, including:
    • Node.js/Express backend
    • PostgreSQL database
    • Python-based computer vision pipeline (OpenCV + OCR)
    • Frontend interface
  • A structured breakdown of the project directory and components
  • A full list of contributors involved in the project

This allows readers to quickly understand the system’s purpose, functionality, and contributors.

2. Installation Documentation

The INSTALLATION.md provides detailed, step-by-step instructions for setting up and running the system.

It includes:

  • Required system dependencies:
    • Node.js
    • PostgreSQL
    • Python
  • Database setup and migration execution
  • Backend configuration and environment variables
  • Installation of required dependencies (npm and pip)
  • Running the backend server
  • Setting up and running the AI detection pipeline
  • Serving and accessing the frontend interface
  • System testing and verification steps

The guide also includes troubleshooting tips and a recommended startup workflow, ensuring users can successfully install and run the project.

3. Supporting Configuration and Structure

In addition to the primary documentation files, the repository includes supporting files that enhance clarity and usability:

  • camera_config.json for mapping cameras to parking locations
  • package.json and requirements.txt for dependency management
  • Database migration scripts for schema creation

The project is organized into clearly defined directories:

  • backend/ – API routes, controllers, and models
  • ai-service/ – detection and OCR processing
  • mobile-app/ – frontend interface
  • database/ – schema and migrations

This structured organization improves readability and makes the system easier to navigate and maintain.

4. Usability and Practical Documentation

The project includes a functional frontend interface that demonstrates real user workflows such as:

  • Vehicle search
  • Manual check-in
  • Viewing parking data

This acts as practical, interactive documentation, helping users understand how the system behaves in real-world scenarios.