Skip to content

docs: update README and add project overview Excel report#18

Merged
shibinsp merged 1 commit into
mainfrom
docs/issue-17-readme-excel-report
Mar 14, 2026
Merged

docs: update README and add project overview Excel report#18
shibinsp merged 1 commit into
mainfrom
docs/issue-17-readme-excel-report

Conversation

@shibinsp

Copy link
Copy Markdown
Owner

Summary

  • Rewrote README.md with professional structure including CI/CD badges, live demo section, feature categories, architecture diagram, E2E test results table, API endpoints, security measures, and RBAC matrix
  • Created docs/reports/TaskPulse_Project_Overview.xlsx with 6 styled sheets: Features (46 rows), E2E Test Results (113 rows), Security (19 measures), Tech Stack (45 deps), API Endpoints (80 endpoints), Architecture (23 components)
  • Updated Playwright config and helpers for deployed app testing via E2E_BASE_URL env var
  • Added test:e2e:deployed npm script

Test plan

  • Verify README renders correctly on GitHub
  • Verify Excel opens with all 6 sheets populated
  • Run E2E_BASE_URL=https://relaxed-gates.vercel.app npx playwright test to confirm E2E config works

Fixes #17

- Rewrite README with professional structure: badges, live demo, feature
  categories, tech stack, architecture diagram, getting started guide,
  E2E test results, CI/CD pipeline, project structure, API endpoints,
  security measures, and RBAC matrix
- Create docs/reports/TaskPulse_Project_Overview.xlsx with 6 sheets:
  Features (46), E2E Test Results (113), Security (19), Tech Stack (45),
  API Endpoints (80), Architecture (23)
- Update Playwright config for deployed app testing via E2E_BASE_URL
- Add test:e2e:deployed npm script

Fixes #17
Co-Authored-By: Beeax
@shibinsp shibinsp merged commit 1033875 into main Mar 14, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

🚀 Vercel Preview Deployment

Status URL
✅ Deployed https://relaxed-gates-et9r25dy8-shibinsps-projects.vercel.app

Commit: 5984b06
Branch: docs/issue-17-readme-excel-report

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.

docs: update README and add project overview Excel report

1 participant