Skip to content

lazy-universe/viewbox

Repository files navigation

TestMail Dashboard

A modern, minimal email viewer dashboard for TestMail API that runs entirely in the browser.

Features

  • View and explore emails received through Testmail.app using your API key
  • Authentication via API key stored in localStorage
  • Filter emails by tags
  • View HTML or plain text email content
  • Download original .eml files
  • Clean and minimal UI

Tech Stack

  • React + TypeScript
  • Vite
  • Tailwind CSS
  • React Router
  • Axios for API requests
  • date-fns for date formatting

Getting Started

Prerequisites

  • Node.js (v16+)
  • npm or yarn

Installation

  1. Clone this repository
git clone <repository-url>
cd testmail-dashboard
  1. Install dependencies
npm install
# or
yarn install
  1. Start development server
npm run dev
# or
yarn dev
  1. Open your browser and navigate to http://localhost:5173

Building for Production

npm run build
# or
yarn build

The build artifacts will be stored in the dist/ directory.

Self-hosting

To self-host this application:

  1. Build the project as described above
  2. Deploy the contents of the dist directory to any static site hosting service like:
    • GitHub Pages
    • Netlify
    • Vercel
    • Firebase Hosting
    • AWS S3 + CloudFront

Since this is a client-side only application, you don't need a server to run it.

Usage

  1. On the login screen, enter your TestMail API key
  2. The dashboard will display your emails in the left sidebar
  3. Click on an email to view its contents in the main area
  4. Filter emails by tag using the tag buttons at the top of the sidebar

Security Note

This application stores your API key in the browser's localStorage. It is recommended to use test keys rather than production keys. The API key is only used for authenticating with the TestMail API and is never sent anywhere else.

About

Minimal browser-based dashboard for viewing and managing Testmail inboxes using the Testmail API.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages