Assignment 3

Release 1.2

Links to Submitted Files

• CI/CD ADR
• FE language ADR
• FE framework ADR
• FE + BE Telemetry ADR
• FE testing ADR
• Cloud provider ADR
• BE architecture ADR
• BE language + framework ADR
• BE testing ADR
• DB ADR
• Azure speech ADR
• Architecture diagram
• Use cases
• Use case 1: Reading karaoke UI sketch
• Use case 2: Long reading UI sketch
• Use case 3: Convobot UI sketch
• Use case 4: Dashboard UI sketch

Progress and Contents Summary

In this release, our team has made significant progress in designing the use cases and technical architecture for our solution. This submission includes:

• ADRs #26 #27 #28 #29 #30 #33 #34
• Use cases and related lo-fi sketches #31
• Architecture diagram #32
• Updating our ADR numbering convention #34

Summaries of Issues Addressed

The following issues were addressed since the last release:

1. DCS-1

   • Description: Write ADR for backend language and framework.
   • Resolution: Decided on Django as the backend framework, running on Azure App Services.

2. DCS-2

   • Description: Write ADRs for frontend language and framework.
   • Resolution: Selected React with Next.js for the frontend framework.

3. DCS-3

   • Description: Write ADR for database choice.
   • Resolution: Decided on PostgreSQL hosted on Azure for the database.

4. DCS-8

   • Description: Write ADR for hosting provider and infrastructure.
   • Resolution: Chose Azure App Services as the hosting platform.

5. DCS-9

   • Description: Write ADR for backend telemetry.
   • Resolution: Integrated Sentry for backend monitoring and telemetry, merged ADR write-up into the front-end telemetry ticket.

6. DCS-10

   • Description: Write ADR for frontend telemetry.
   • Resolution: Decided to use Sentry for frontend monitoring and telemetry.

7. DCS-11

   • Description: Write ADR for CI/CD solution.
   • Resolution: Implemented GitHub Actions for CI/CD pipelines.

8. DCS-6

   • Description: Create architecture diagram.
   • Resolution: Designed architecture diagram including all of the directly production-facing tools we currently plan to use.

9. DCS-17

   • Description: Write ADR for backend architecture.
   • Resolution: Decided on a monolithic architecture with Django as the server app.

10. DCS-21

    • Description: Write ADR for FE Testing.
    • Resolution: Chose Playwright as the frontend testing framework.

11. DCS-24

    • Description: Write ADR for BE Testing.
    • Resolution: Decided on Pytest as the backend testing framework.

12. DCS-18

    • Description: Add lo-fi sketches of use cases.
    • Resolution: Integrated into use cases descriptions

13. DCS-19

    • Description: Add use cases
    • Resolution: Wrote up preliminary use cases with descriptions and relationship to tech stack.

14. DCS-30

    • Description: Write ADR on cloud speech service utilities
    • Resolution: Decided on Azure Speech Services for our pronunciation-specific use cases.

15. DCS-25

    • Description: Update ADR README with our conventions
    • Resolution: Documented our new ADR naming conventions in the ADR README.

Changes to the Roadmap, Architecture, or Use Cases

Roadmap Updates

• Roadmap was made to provide our team a sense of direction.

Architecture Updates

• Included a new architecture diagram to indicate our initial direction as we commence development.
• Added ADRs reflecting our new architecture: Django as the backend framework, React with Next.js for the frontend, PostgreSQL for the database, Azure App Services for hosting, Sentry for backend and frontend telemetry, GitHub Actions for CI/CD, a monolithic architecture, Playwright for frontend testing, and Pytest for backend testing.

Use Case Updates

• Four proposed use cases have been added to the repository under the product_research folder, as per assignment guidelines. They will be discussed and approved / modified in consultation with the teaching team during / after Demo 1.

Additional Notes

None