Skip to content

docs: add ARCHITECTURE.md, Playwright E2E tests, and doc fixes#11

Merged
ravishan16 merged 1 commit intomainfrom
docs/architecture-e2e-tests
Mar 10, 2026
Merged

docs: add ARCHITECTURE.md, Playwright E2E tests, and doc fixes#11
ravishan16 merged 1 commit intomainfrom
docs/architecture-e2e-tests

Conversation

@ravishan16
Copy link
Copy Markdown
Owner

Summary

Adds comprehensive architecture documentation, a Playwright E2E test suite, and fixes several documentation issues.

Changes

New Files

  • ARCHITECTURE.md (670 lines) — Full technical architecture guide with Mermaid diagrams covering system overview, frontend/backend architecture, DB schema (ER diagram), data flow, design system (color tokens, glassmorphism, typography, animations), CI/CD pipeline, local development guide, and testing guide

  • playwright.config.ts — Playwright config: Chromium, iPhone 14 viewport (390×844), 30s timeout

  • e2e/app.spec.ts — 11 E2E tests across 6 groups:

    Group Tests Coverage
    Today Page 2 Empty state, bottom nav tabs
    Routine Management 2 Create single & multiple routines
    Completion Flow 1 Toggle checkbox, progress updates
    Dashboard 2 Empty state, stats after completions
    Settings 3 Sections, Google sign-in, footer links
    Navigation 1 Navigate all 4 main pages

Modified Files

  • README.md — Fixed banner image (icon-512.pnglogo.svg), streamlined Quick Start (Node 20+), expanded Testing section with E2E setup instructions
  • DEPLOYMENT.md — Fixed broken local file:/// link → Google's official OAuth docs
  • package.json — Added @playwright/test devDep, test:e2e and test:e2e:headed scripts
  • .gitignore — Added Playwright artifacts (test-results/, playwright-report/, .playwright-mcp/)

How to Test

# Unit tests
npm run test

# E2E (requires local Worker on :8787 + Vite on :5173)
npm run test:e2e            # headless
npm run test:e2e:headed     # visible browser

Verification

  • ✅ 19/19 unit tests pass
  • ✅ 11/11 E2E tests pass (headless)
  • ✅ 11/11 E2E tests pass (headed / visible browser)
  • tsc clean
  • ✅ Production build succeeds

- Add comprehensive ARCHITECTURE.md (670 lines) with Mermaid diagrams,
  design system tokens, CI/CD pipeline, local dev guide, and testing guide
- Add Playwright E2E test suite (11 tests across 6 groups) covering
  Today page, routine management, completion flow, dashboard, settings,
  and navigation
- Add playwright.config.ts (Chromium, iPhone 14 viewport)
- Fix README banner image (icon-512.png → logo.svg)
- Streamline README Quick Start (Node 20+), expand Testing section
  with E2E instructions and 3-terminal setup
- Fix DEPLOYMENT.md broken local file:/// link → Google OAuth docs
- Add @playwright/test devDependency with test:e2e scripts
- Add Playwright artifacts to .gitignore
@ravishan16 ravishan16 merged commit 22dfeb2 into main Mar 10, 2026
2 checks passed
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the project with detailed architecture documentation, a suite of E2E tests, and several documentation improvements. These changes collectively improve the project's maintainability, testability, and provide better guidance for developers and users.

Highlights

  • Architecture Documentation: Introduced a comprehensive ARCHITECTURE.md file detailing the system's architecture, design system, CI/CD pipeline, and local development setup.
  • Playwright E2E Tests: Added a Playwright E2E test suite covering key app functionalities, ensuring end-to-end reliability.
  • Documentation Fixes: Corrected broken links and improved the README.md and DEPLOYMENT.md files for better user guidance.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .gitignore
    • Added Playwright artifacts (test-results/, playwright-report/, .playwright-mcp/) to the ignore list.
  • ARCHITECTURE.md
    • Added a comprehensive architecture guide with diagrams and details on the system overview, frontend/backend architecture, database schema, data flow, design system, CI/CD, local development, and testing.
  • DEPLOYMENT.md
    • Fixed a broken local file link to Google's official OAuth documentation.
  • README.md
    • Updated banner image, streamlined Quick Start instructions, and expanded the Testing section with E2E setup instructions.
  • e2e/app.spec.ts
    • Implemented E2E tests covering Today Page, Routine Management, Completion Flow, Dashboard, Settings, and Navigation.
  • package.json
    • Added @playwright/test as a dev dependency and included test:e2e and test:e2e:headed scripts.
  • playwright.config.ts
    • Added Playwright configuration file for E2E testing, specifying Chromium browser, iPhone 14 viewport, and timeout settings.
Activity
  • 19/19 unit tests pass
  • 11/11 E2E tests pass (headless)
  • 11/11 E2E tests pass (headed / visible browser)
  • tsc clean
  • Production build succeeds
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a fantastic addition to the project, introducing comprehensive architecture documentation and a solid foundation for E2E testing with Playwright. The new ARCHITECTURE.md is exceptionally detailed and will be a great resource for current and future contributors. The documentation fixes and updates to the README.md also significantly improve the developer experience. I have one minor suggestion to fix a rendering issue in the README.md.

Comment thread README.md
- **Backend (Optional Sync)**: Cloudflare Workers (Hono), Cloudflare D1 (SQLite)

## 🛠️ Installation & Development
## � Architecture
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The emoji for the "Architecture" section heading is not rendering correctly and appears as a replacement character (``). Please replace it with a suitable emoji like 🏛️ or `🏗️` to improve the document's readability.

Suggested change
## Architecture
## 🏛️ Architecture

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant