TAP‐Home - fuhui14/SWEN90017-2024-TAP GitHub Wiki

Welcome to the SWEN90017-2024-TAP wiki!

🎯 Introduction

This project aims to develop a transcription platform that operates in a local environment using OpenAI's Whisper software. The platform is intended for a team working within a secure local area network (LAN), enabling users to upload audio files for transcription without requiring user login.

📝 catalogue

• 🏠 Transcription Aide Platform(TAP)

• 👥 About the Team

• 🛠️ Setup & Configuration

  • 🔧 Setup Guide
  • ⚛️ Front‐End Configuration
  • 🐍 Back‐end Configuration
  • 🗄️ Database and File Management
  • 📚 Speak Library Research
  • 💻 Technology Decision

• 📐 Architecture & Design

  • 🖼️ Component Diagram
  • 🖼️ Deployment Diagram
  • 🖼️ Class Diagram
  • 🖼️ Domain Model
  • 🖼️ ER Diagram
  • 🖼️ Sequence Diagram
  • 🖼️ Use Case Diagram
  • 🖼️ Activity Diagram
  • Integration Document
    • 🔗 Frontend‐Backend Integration – Epic 1 (File Upload)
  • Interface Document
    • 📜 Interface – Epic 1: File Upload
    • 📜 Interface – Epic 2&3: Transcription
    • 📜 Interface – Epic 4: File Management

• Requirements

  • 🔖 Software Requirements Specification
  • 📚 User Story (pdf)
  • 👩 Personas
  • 🗝️ Acceptance Criteria
  • 🎐 Motivation Model
  • 🌕 Mood Board (PDF)

• 🔍 Agile Process & Meetings

  • 📌 Sprint Planning
  • 🔁 Sprint Retrospectives
  • 👀 Sprint Reviews
  • 📆 Team Meetings
  • 🧑‍💼 Client Meetings

• 🧪 QA & Standards

  • ⚖️ Code Review Standards
  • 📔 Git Commit Standards
  • 👁️‍🗨️ BUG Report
  • 💬 Communication Plan

• ⚠️ Risk Management

  • ♦️ Risk Management Plan

• 📦 Project Assets

  • 🃏 Project Artifacts List (PDF)