Page 1 of 4
System Requirements Document for Project: rapid
1. Introduction
The project "rapid" is designed to develop a lightweight, production-ready Micro-SaaS called "ProofBox." ProofBox is a Testimonial Collection and Social Proof Embed Widget aimed at creators, freelancers, and e-commerce stores. The focus is on solid CRUD operations, clean database architecture, and frictionless frontend widgets.
2. System Overview
ProofBox is a non-AI based tool that provides a simple and efficient way to collect and display testimonials. It is built using Next.js for the frontend, Supabase for the backend and database management, and integrates Stripe for billing. The deployment is handled via Vercel, ensuring a seamless and fast user experience.
3. Functional Requirements as Story Points
- As a User, I should be able to create and manage projects within the dashboard.
- As a User, I should be able to view overall statistics of my projects, including total and approved reviews.
- As a User, I should be able to approve or delete testimonials from a tabbed review inbox.
- As a User, I should be able to generate a public collection page for clients to submit testimonials.
- As a User, I should be able to generate and copy an embed code for testimonials to use on external sites.
- As a User, I should be able to select different layout types for the embed widget.
- As a User, I should be able to manage my subscription and billing through Stripe.
- As a User, I should be able to customize widget settings such as theme, accent color, and layout.
Page 2 of 4
4. User Personas
- Creator: Individuals who create content and need to showcase testimonials to enhance credibility.
- Freelancer: Professionals offering services who want to display client feedback to attract more clients.
- E-commerce Store Owner: Business owners who wish to display customer reviews to boost sales.
5. Core User Flows
- User logs in -> Creates a new project -> Configures widget settings -> Shares public collection page link -> Collects testimonials -> Approves testimonials -> Embeds widget on their site.
- User logs in -> Views dashboard -> Checks review inbox -> Approves or deletes testimonials -> Updates project settings.
6. Visuals Colors and Theme
- primary:
#1E293B (slate-900)
- primary_light:
#334155 (slate-700)
- secondary:
#F59E0B (amber-400)
- accent:
#F59E0B (amber-400)
- highlight:
#FBBF24 (amber-300)
- bg:
#FFFFFF (white)
- surface:
#F1F5F9 (slate-100)
- text:
#1E293B (slate-900)
- text_muted:
#64748B (slate-500)
- border:
#E2E8F0 (slate-200)
Page 3 of 4
7. Signature Design Concept
Interactive Testimonial Carousel: The landing page will feature an interactive carousel of testimonials that users can swipe through. Each testimonial card will flip to reveal more details when clicked. The carousel will have a dynamic background that changes color based on the testimonial's rating, creating an engaging and visually appealing experience. This will be implemented using motion/react for smooth animations and transitions.
Landing Hero Motion Brief
The hero section will feature a continuously moving carousel of testimonial cards. Each card will display a snippet of a testimonial, and users can click to expand the card for more details. The carousel will loop every 10 seconds, with a smooth transition between cards. The background will subtly change colors to match the testimonial's rating, providing a visual cue of the feedback's positivity.
8. Interaction Model & Motion Direction
- Interaction Model: Animated
- The landing page will feature moderate scroll-triggered reveals and hover transitions. The testimonial carousel will have spring physics for interactive elements, providing a polished and engaging user experience.
9. Non-Functional Requirements
- The system must be responsive and perform well on mobile, tablet, and desktop devices.
- The system must ensure data security and privacy, particularly for user testimonials and billing information.
- The system must be scalable to handle an increasing number of users and testimonials.
Page 4 of 4
10. Tech Stack
- Frontend: Next.js, Tailwind CSS, Lucide React
- Backend/Database: Supabase (PostgreSQL, Auth, Row Level Security, Storage)
- Billing Integration: Stripe
- Deployment: Vercel
11. Assumptions and Constraints
- The system will be deployed on Vercel, leveraging its CDN for fast content delivery.
- Supabase will handle authentication and database management, ensuring secure and efficient data handling.
- Stripe will manage billing and subscription services, providing a reliable payment gateway.
12. Glossary
- CRUD: Create, Read, Update, Delete
- SaaS: Software as a Service
- B2B: Business to Business
- RLS: Row Level Security
- CDN: Content Delivery Network
This document outlines the requirements and design specifications for the "ProofBox" project within the "rapid" initiative. It serves as a comprehensive guide for developers and designers to build and deploy the application effectively.
No comments yet. Be the first!