Documentation

Everything you need to get started with ForgetMeNot

Quick Start

iOS App
Get started in 2 minutes
  1. 1.Download from App Store (iOS 14+)
  2. 2.Create account or use anonymously
  3. 3.Grant contact & notification permissions
  4. 4.Import contacts and start using
Download on App Store
Self-Hosted
Deploy in 10 minutes
  1. 1.Clone the GitHub repository
  2. 2.Set up Supabase backend
  3. 3.Configure environment variables
  4. 4.Deploy with EAS or TestFlight
View on GitHub

Documentation

Getting Started
  • • Installation Guide
  • • First-Time Setup
  • • Importing Contacts
  • • Creating First Reminder
  • • Using AI Features
User Guide
  • • Smart Reminders
  • • AI Message Generation
  • • Gift Quiz Flow
  • • Memory Vault
  • • Gesture Automation
Configuration
  • • App Settings
  • • Privacy Controls
  • • Notification Preferences
  • • AI Provider Selection
  • • Data Export/Import
Self-Hosting
  • • System Requirements
  • • Supabase Setup
  • • Environment Variables
  • • Building from Source
  • • Deployment Options
Architecture
  • • Technology Stack
  • • Database Schema
  • • API Reference
  • • Component Catalog
  • • State Management
Privacy & Security
  • • Privacy Principles
  • • Data Handling
  • • Row-Level Security
  • • On-Device Processing
  • • GDPR Compliance
Contributing
  • • Code of Conduct
  • • Development Setup
  • • Pull Request Process
  • • Testing Guidelines
  • • Style Guide
API Reference
  • • REST API
  • • GraphQL Schema
  • • Webhooks
  • • Authentication
  • • Rate Limits
Troubleshooting
  • • Common Issues
  • • Error Messages
  • • Performance Tips
  • • Debugging Guide
  • • Support Resources

Self-Hosting Quick Guide

1. Prerequisites

• Node.js 20+ and npm

• Supabase account (free tier works)

• Expo CLI (npm install -g expo-cli)

• iOS device or simulator (for testing)

2. Clone & Install
git clone https://github.com/forgetmenot/app.git
cd forgetmenot
npm install
3. Supabase Setup

• Create new Supabase project at supabase.com

• Run database migrations from /supabase/migrations

• Copy project URL and anon key

• Enable Row Level Security on all tables

4. Environment Variables

Create .env file in project root:

EXPO_PUBLIC_SUPABASE_URL=your_supabase_url
EXPO_PUBLIC_SUPABASE_ANON_KEY=your_anon_key
EXPO_PUBLIC_OPENAI_API_KEY=your_openai_key
EXPO_PUBLIC_ANTHROPIC_API_KEY=your_claude_key
5. Run & Deploy
# Development
npm run dev

# Build for iOS
npm run build:ios

# Deploy with EAS
eas build --platform ios
eas submit --platform ios

Need Help?

For detailed self-hosting instructions, architecture documentation, and API reference, visit our comprehensive docs site or join the community.

Full DocumentationGitHub RepositoryJoin Discord

Technology Stack

Frontend

• Expo SDK 54 (React Native 0.81)

• TypeScript 100% coverage

• Tamagui design system

• React Navigation 7

• Jest testing framework

Backend

• Supabase (PostgreSQL + Auth)

• Row-level security (RLS)

• Edge Functions (Deno runtime)

• Real-time subscriptions

• Storage for assets

AI & ML

• OpenAI API (GPT-4)

• Anthropic Claude API

• Expo Speech Recognition

• Prompt version control

• Context-aware generation

DevOps

• GitHub Actions CI/CD

• EAS Build & Submit

• TestFlight distribution

• OTA updates

• Automated testing