Skip to main content

My Dashboard Documentation

Welcome to the My Dashboard documentation! This is a comprehensive Cypress test results dashboard with JIRA integration, built as a full-stack TypeScript monorepo.

🎯 What is My Dashboard?​

My Dashboard is a modern web application designed to aggregate, visualize, and manage Cypress E2E test results alongside development workflows. It provides:

  • Real-time E2E Test Monitoring - Track Cypress test execution results across multiple applications
  • Pull Request Integration - Monitor GitHub pull requests and their test status
  • JIRA Integration - View and manage JIRA tickets directly from the dashboard
  • Task Management - Built-in to-do list for tracking development tasks
  • Push Notifications - Real-time alerts via Firebase Cloud Messaging
  • Application Monitoring - Track multiple projects and their test health

🏗️ Architecture Overview​

🚀 Technology Stack​

Frontend​

  • React 19 - Modern React with latest features
  • Vite - Fast build tool and development server
  • TypeScript - Type-safe development
  • Material-UI (MUI) - Component library
  • React Router - Client-side routing

Backend​

  • Express.js - Web application framework
  • TypeScript - Type-safe server code
  • MySQL 8.0 - Relational database
  • mysql2 - Database client (raw SQL)

Infrastructure​

  • pnpm - Fast, disk space efficient package manager
  • Railway - Hosting and deployment
  • GitHub Actions - CI/CD pipeline
  • Docusaurus - Documentation site (this site!)

📚 Documentation Sections​

Getting Started​

Architecture​

Development​

SDK​

API Reference​

Other Resources​

🎓 Quick Links​

🤝 Contributing​

We welcome contributions! Please read our Contributing Guide to get started.

📝 License​

This project is licensed under the terms specified in the LICENSE file.

Need Help? Check out our FAQ or Troubleshooting Guide.