MyStoryFlow Documentation
Your complete guide to building and maintaining the MyStoryFlow platform.
Quick Start
New to MyStoryFlow? Start here to get up and running quickly.
Overview
Learn what MyStoryFlow is and how it works
Getting Started
Set up your development environment
Architecture
Understand how the platform is built and how the pieces fit together.
System Architecture
Monorepo structure, shared packages, and system design
Database Schema
Tables, relationships, and data models
Deep Dives:
Applications
Documentation for each application in the monorepo.
Platform App
Main web application for users
Admin Dashboard
Administrative interface for managing users and content
Marketing Site
Public website and landing pages
Tools App
Writing tools and utilities for authors
Development
Everything you need to build features and contribute to the codebase.
Development Guide
Local setup, coding standards, and workflows
API Reference
REST API endpoints and authentication
Components
Reusable UI components and design system
Tools Framework
Building custom tools for the Tools App
Deployment & Operations
Deploy, monitor, and maintain the platform.
Deployment
Vercel deployment and CI/CD pipeline
Email System
Transactional and marketing emails
Analytics
User analytics and monitoring
Integrations
Third-party services and APIs
Business & Users
Product documentation and business context.
Features
Complete feature documentation
User Guides
End-user documentation and tutorials
Business Model
Pricing, subscriptions, and business strategy
Use Cases
User flows and testing scenarios
Security & Compliance
Security measures and legal requirements.
Security
Authentication, authorization, and data protection
Legal & Compliance
Privacy policy, terms, and GDPR compliance
Technical Deep Dives
In-depth technical documentation for core systems.
Reference
Quick reference guides and specifications.