GitHub Setup 🔧

📋 First: Connect GitHub

1. Create Repository: Make a new private GitHub repository (e.g., "our-space-data")
2. Generate PAT:
   • Go to github.com/settings/tokens
   • Click "Generate new token (classic)"
   • Select scopes: repo (all)
   • Generate and copy token
3. Enter Credentials: Provide repo name and token on first screen

👤 Then: Choose Username

After GitHub connection is verified:

• Enter your desired username
• If username exists in the repo → Login automatically
• If username doesn't exist → Account created automatically
• Credentials saved locally for future logins

🔐 Master File System

A master_user_{username}.txt file is automatically created containing:

• All rooms you've created
• All rooms you've joined
• Quick access information
• Synced across all your devices

⚠️ Important

• Keep your PAT secret - never share it
• Use the SAME repo + PAT on all devices
• Both partners can use same repo OR separate repos

Login Flow 🔄

🚀 First Time Setup

1. Step 1: Enter GitHub repo and PAT
2. Step 2: System verifies connection
3. Step 3: Choose username
4. Step 4: Master file created automatically
5. Step 5: Ready to create/join rooms!

🔄 Returning User

If you've used the app before on this browser:

• GitHub credentials auto-loaded from browser
• Just enter your username
• Loads your master file
• Shows all your rooms instantly

💻 Multiple Devices

To use on another device:

1. Enter same GitHub repo and PAT
2. Enter same username
3. All rooms sync automatically

🔗 Shared vs Separate Repos

• Shared Repo: Both partners use SAME repo/PAT → instant sync
• Separate Repos: Each person uses OWN repo → creator's repo stores room data
• Room data always stored in creator's repository

Room Types & Management 🏠

💕 Love Rooms

For romantic relationships. Special features:

• 💔 Breakup: Request room deletion (all must agree)
• 🚶 Move On: Leave silently (auto-deletes if all leave)
• 🏛️ Freeze: Make read-only forever
• Pink/purple theme

👫 Friendship Rooms

For friends and platonic relationships:

• 🚪 Leave: Exit room cleanly
• 🏛️ Freeze: Make read-only forever
• No breakup mechanics
• Yellow theme

🎨 Room Naming

• Set custom name when creating room
• Admin can rename anytime in settings
• Room code remains same
• Name shown in room list

👑 Admin Powers

• Approve/deny join requests
• Rename room
• Freeze room
• Initiate breakup (love rooms)
• If admin leaves, next member becomes admin

Multiple Rooms 🗂️

📊 Room Dashboard

Access from home page to see:

• All rooms you've created
• All rooms you've joined
• Room type indicators (love/friendship)
• Active room highlighted
• Click any room to switch

🔄 Room Switching

1. Go to home page
2. Click on any room card
3. System loads that room's data
4. Navigation updates to show current room
5. All features work for active room

➕ Creating Multiple Rooms

• No limit on room creation
• Each gets unique 6-character code
• All tracked in your master file
• Choose room type for each
• Name each room uniquely

📁 File Structure

Your GitHub repo will contain:

• master_user_{username}.txt - Your room list
• {ROOMCODE}_master.txt - Room file index
• {ROOMCODE}_1.txt, _2.txt... - Room data
• Separate files for each room you create

Important Reminders ⚠️

🔐 Security

• PAT Security: Never share your Personal Access Token
• Repo Privacy: Keep repository private
• Local Storage: GitHub credentials stored in browser only
• No Passwords: Authentication through GitHub PAT only

💾 Data Management

• Sync Speed: 1.5 second refresh for chat/updates
• Image Storage: Base64 embedded (5MB max per image)
• File Splitting: Auto-splits at 50MB per file
• Backups: Your GitHub repo IS your backup

🎯 Best Practices

• Use descriptive room names
• Keep PAT secure and backed up
• Regular GitHub repo backups
• One browser = one set of credentials
• Share room codes carefully

🐛 Troubleshooting

• Can't load rooms: Check GitHub PAT permissions
• Slow sync: Large images may slow down loading
• Lost credentials: Re-enter repo + PAT to restore
• Room not found: Verify room code with partner