Welcome to the IoTBay engineering documentation! This is your comprehensive resource for understanding, developing, and maintaining the IoT Bay E-commerce Platform.
Project: IoT Bay E-commerce Platform
Course: 41025 Information Systems Development (ISD)
Institution: University of Technology Sydney (UTS)
Current Version: 1.0.0
Documentation Version: 1.0.0
Last Updated: December 3, 2025
New to the project? Choose your role below:
- 👨💻 Developer → New Developer Guide (15 min) ⭐
- 🏗️ Architect → Architecture Guide (complete overview)
- 🧪 QA/Tester → Testing Guide (test reference)
- 📋 Project Manager → Project Overview
Want the complete index? → Full Documentation Index ✨
- What is this project? → Project Overview
- What are we building? → Complete Features
- What's the current status? → Project Status Reports
- How is it designed? → Architecture Overview
- Getting started locally? → Development Setup
- Backend architecture? → Backend Guide
- Database schema? → Database Design
- API endpoints? → API Reference
- Contributing code? → Contributing Guidelines
- Frontend setup? → Frontend Guide
- Component architecture? → Component Design
- Design system? → Design System
- TypeScript migration? → TypeScript Guide
- Testing strategy? → Testing Overview
- How to test? → Test Strategy
- Error prevention? → Error Prevention Guide
- Accessibility testing? → A11y Testing Guide
- Local deployment? → Local Deployment
- Production deployment? → Production Deployment
- Docker setup? → Docker Guide
- I'm new, where do I start? → Getting Started
- What's the tech stack? → Tech Stack
- How's the code organized? → Project Overview
- Git workflow? → Git Workflow
1️⃣ Getting Started 1_getting-started/
For: Onboarding new team members, quick references
Contains: Project overview, quickstart guides, tech stack, local setup
2️⃣ Architecture 2_architecture/
For: Understanding system design, component organization
Contains: High-level design, component architecture, database schema, API design, security
3️⃣ Requirements 3_requirements/
For: Feature specifications, acceptance criteria, API contracts
Contains: Feature list, user stories, API reference, acceptance criteria
4️⃣ Development 4_development/
For: Development guides, contribution workflows, deployment
Contains: Dev setup, code guidelines, deployment procedures, troubleshooting
5️⃣ Testing 5_testing/
For: QA strategies, test execution, quality verification
Contains: Test strategies, testing guides, error prevention, test data
6️⃣ Planning 6_planning/
For: Roadmaps, migrations, design reviews
Contains: Project roadmap, migration guides, design reviews
7️⃣ Reports 7_reports/
For: Project status, analysis reports, reviews
Contains: Status updates, audit results, periodic reviews
8️⃣ Archive 8_archive/
For: Historical reference only
Contains: Old sprint docs, deprecated guides, migration history
🌍 Internationalization i18n/
For: International team members
Contains: Japanese (ja/), Korean (ko/) documentation
- User Management: FR-001
- Product Catalog: FR-002
- E-commerce: FR-003
- Reviews & Ratings: FR-004
- Admin Features: FR-005
- Database: Database Design
- API: API Reference
- Authentication: Security Architecture
- Deployment: Deployment Guide
- Testing: Test Strategy
- Error Prevention: Error Prevention
- Accessibility: A11y Guide
First time here? Follow these steps:
- Read Project Overview (5 min)
- Choose your role above
- Follow the recommended reading path
- Bookmark frequently-used documents
All documentation is part of the IoT Bay project (UTS 41025 ISD Assignment 2).
Last Updated: December 3, 2025
Documentation Version: 1.0.0
Status: Active
Document Version: 1.0.0 Audience: Developers, Stakeholders Maintained By: IoT Bay Documentation Team