System Requirements Document (SRD)

Project Name: sweet-email

1. Introduction

The sweet-email project is a simple and user-friendly system designed to collect user information and send personalized emails automatically. This document outlines the system requirements for the project, ensuring clarity and alignment with the vision shared by Tal Mendelson.

The app focuses on delivering a seamless experience for users in Israel (IL), with locale-specific considerations such as timezone (UTC+2) and email validation standards.

2. System Overview

The sweet-email system is built to provide users with a straightforward and delightful experience. Users can enter their name and email address, click a button, and receive a personalized email almost instantly.

Key Features:

• Ease of Use: Minimal input fields and a single button for interaction.
• Personalization: Emails include the user's name for a personal touch.
• Security: Email validation and CAPTCHA integration to prevent spam and abuse.

Workflow:

1. User enters their name and email address.
2. System validates the email format and checks for spam.
3. A personalized message is generated.
4. The email is sent using reliable backend services like SendGrid or Mailgun.

3. Functional Requirements

User Stories:

• As a User, I should be able to enter my name and email address into the app.
• As a User, I should be able to click a "Send" button to receive a personalized email.
• As a User, I should receive an email with my name included in the message.
• As a User, I should be prevented from submitting invalid email addresses.
• As a User, I should encounter CAPTCHA verification to ensure I am not a bot.

4. User Personas

1. User

• Description: Individuals who want to receive personalized emails.
• Goals: Enter their name and email, receive a personalized email quickly.
• Pain Points: Avoiding spam and ensuring their email is valid.

2. Admin (Future Persona)

• Description: Oversees the system, manages email templates, and monitors usage.
• Goals: Ensure smooth operation and prevent abuse.
• Pain Points: Managing spam and scaling the system as user volume grows.

5. Visuals Colors and Theme

Color Palette:

The sweet-email app will use a fresh and inviting color scheme to evoke simplicity and warmth.

• Background: #F9F6F2 (Soft Cream)
• Surface: #FFFFFF (Pure White)
• Text: #333333 (Deep Charcoal)
• Accent: #FF6F61 (Warm Coral)
• Muted Tones: #C4C4C4 (Light Gray)

6. Signature Design Concept

Concept: Interactive Email Envelope Animation

The homepage will feature an animated envelope that "opens" when the user clicks the "Send" button.

Details:

• Animation: The envelope starts closed and sealed. When the user clicks "Send," it opens, revealing a letter with their name on it.
• Micro-interactions: The envelope shakes slightly when hovered over, inviting the user to interact.
• Transitions: Smooth fade-ins and slide-outs for the envelope and letter.
• Color Shifts: The envelope changes color slightly when clicked, transitioning from muted tones to the accent coral (#FF6F61).
• Sound: A subtle "paper rustling" sound accompanies the animation for added immersion.

This design ensures the app feels delightful and memorable, creating a lasting impression for users.

7. Non-Functional Requirements

• Performance: The system must send emails within 5 seconds of submission.
• Scalability: The backend should support up to 10,000 email submissions per day.
• Security: CAPTCHA integration to prevent bot abuse.
• Reliability: Ensure 99.9% uptime for email-sending services.

8. Tech Stack

Frontend:

• React for Web

Backend:

• Python
• FastAPI

Database:

• MySQL or MariaDB (using Alembic for migrations)

AI Tools:

• Litellm for LLM Routing

Local Orchestration:

• Docker
• docker-compose

Server-side Orchestration:

• Kubernetes

Email Services:

• SendGrid or Mailgun

9. Assumptions and Constraints

Assumptions:

• Users will primarily access the app from Israel (IL).
• The app will initially support only English for email content.
• CAPTCHA will be sufficient to prevent spam without additional measures.

Constraints:

• The system will not store user data or email history at this stage.
• The app must comply with GDPR and local data protection laws.

10. Glossary

• CAPTCHA: A security measure to differentiate between human users and bots.
• SMTP: Simple Mail Transfer Protocol, used for sending emails.
• SendGrid/Mailgun: Third-party services for reliable email delivery.
• Alembic: A database migration tool for Python.
• Docker: A tool for containerizing applications.
• Kubernetes: A system for automating deployment, scaling, and management of containerized applications.