Files
1356/lifetimer/USER_GUIDE.md
T
Tomas Dvorak 37ffb93923 feat: Complete Phase 1 - Full Flutter app implementation with comprehensive features
Version: 1.1.0

Major changes:
- Implemented complete Flutter app structure with all core features
- Added comprehensive UI screens for auth, countdown, goals, profile, settings, and social features
- Integrated Supabase backend with authentication and data repositories
- Added offline support with Hive caching and local storage
- Implemented comprehensive routing with go_router
- Added location services with Google Maps integration
- Implemented notifications and home widget support
- Added voice recording capabilities and AI chat features
- Created comprehensive test suite and documentation
- Added Android and iOS platform configurations
- Implemented achievements system and social features
- Added calendar integration and bucket list functionality

This represents a complete Phase 1 milestone with 3,775 additions across 31 files.
2026-01-04 14:33:54 +01:00

550 lines
12 KiB
Markdown

# LifeTimer - User Guide
## Table of Contents
1. [Getting Started](#getting-started)
2. [Creating Your Account](#creating-your-account)
3. [Understanding the 1356-Day Challenge](#understanding-the-1356-day-challenge)
4. [Creating Your Bucket List](#creating-your-bucket-list)
5. [Tracking Your Progress](#tracking-your-progress)
6. [Using the Countdown](#using-the-countdown)
7. [Social Features](#social-features)
8. [Analytics & Insights](#analytics--insights)
9. [Settings & Customization](#settings--customization)
10. [Tips for Success](#tips-for-success)
---
## Getting Started
Welcome to LifeTimer! This guide will help you make the most of your 1356-day journey to personal transformation.
### What is LifeTimer?
LifeTimer is a gamified life countdown app that helps you achieve your goals through a focused, time-bound challenge. You create a bucket list of up to 20 life goals, start your 1356-day countdown (3 years, 8 months, and 11 days), and commit to making every day count.
### Why 1356 Days?
This timeframe represents the perfect balance between ambition and achievability. It's long enough to accomplish meaningful transformation but short enough to maintain urgency and focus.
---
## Creating Your Account
### Sign Up Options
LifeTimer offers three ways to create an account:
1. **Email Sign Up**
- Enter your email address
- Create a secure password
- Verify your email address
2. **Google Sign In**
- Tap "Continue with Google"
- Authorize with your Google account
- Your profile is automatically created
3. **Apple Sign In** (iOS only)
- Tap "Continue with Apple"
- Use Face ID or Touch ID to authenticate
- Your profile is automatically created
### Completing Your Profile
After signing up, you'll be prompted to:
1. **Add a Username**: Choose a unique identifier for your profile
2. **Upload an Avatar**: Add a profile picture (optional)
3. **Write a Bio**: Tell others about yourself (optional)
4. **Set Privacy**: Choose between public or private profile
---
## Understanding the 1356-Day Challenge
### The Concept
Once you start your countdown, there's no turning back. The countdown cannot be paused, reset, or extended. This commitment is what makes the challenge powerful.
### The Rules
1. **Create Your Bucket List**: Add up to 20 life goals
2. **Start the Countdown**: Confirm your goals and begin
3. **Track Progress**: Update your goals as you make progress
4. **Stay Committed**: No pauses, no resets, just dedication
### What Happens When the Countdown Ends?
When your 1356 days are complete:
- You'll see a celebration screen
- Your final stats will be displayed
- You can review your entire journey
- You can start a new challenge if desired
---
## Creating Your Bucket List
### Adding Your First Goal
1. Tap the "Goals" tab in the bottom navigation
2. Tap the "+" button to create a new goal
3. Fill in the goal details:
- **Title**: What do you want to achieve?
- **Description**: Why is this goal important to you?
- **Progress**: Set initial progress (0-100%)
- **Location**: Add a location (optional)
- **Image**: Add an inspiring photo (optional)
### Goal Best Practices
**Be Specific**
- ✅ "Learn to play guitar at intermediate level"
- ❌ "Learn guitar"
**Make It Measurable**
- ✅ "Read 24 books in one year"
- ❌ "Read more books"
**Set a Deadline**
- ✅ "Complete a marathon by December 31st"
- ❌ "Run a marathon someday"
**Add Milestones**
Break big goals into smaller steps:
1. Research training programs
2. Start training schedule
3. Complete first 5K
4. Complete first half-marathon
5. Complete full marathon
### Editing Your Goals
You can edit your goals at any time before starting the countdown:
1. Go to the Goals tab
2. Tap on the goal you want to edit
3. Tap the edit icon
4. Make your changes
5. Save your changes
**Note**: Once the countdown starts, you cannot delete goals, but you can still edit details and update progress.
### Adding Images to Goals
You can add images in three ways:
1. **Upload from Device**
- Tap the image field
- Choose "Take Photo" or "Choose from Library"
- Select or take your photo
2. **Search Unsplash**
- Tap "Search Images"
- Enter keywords (e.g., "mountain", "ocean")
- Select an inspiring image
3. **Search Pexels**
- Tap "Search Images"
- Switch to Pexels
- Search and select an image
### Adding Locations
1. **Use Current Location**
- Tap "Use Current Location"
- Allow location access
- Location is automatically added
2. **Pick on Map**
- Tap "Pick on Map"
- Search for a location
- Pin the exact spot
- Save the location
---
## Tracking Your Progress
### Updating Progress
1. Go to the Goals tab
2. Tap on a goal
3. Use the progress slider to update
4. Tap "Save"
### Completing Milestones
If your goal has milestones/steps:
1. Open the goal details
2. Tap on a milestone
3. Mark it as complete
4. Progress automatically updates
### Marking Goals Complete
When you've achieved a goal:
1. Open the goal details
2. Set progress to 100%
3. Tap "Mark as Complete"
4. Celebrate your achievement! 🎉
### Progress Indicators
- **Progress Bar**: Visual representation of completion
- **Percentage**: Exact progress percentage
- **Checkmark**: Appears when goal is complete
- **Color Coding**: Goals change color as they progress
---
## Using the Countdown
### The Home Screen
The home screen displays your countdown with:
- **Large Timer**: Days, hours, minutes, seconds
- **Progress Ring**: Visual percentage of time elapsed
- **Motivational Message**: Changes based on your progress
- **Quick Actions**: View goals, check profile
### Starting the Countdown
**Important**: You can only start the countdown once!
1. Create your bucket list (at least 1 goal)
2. Review your goals carefully
3. Go to the Goals tab
4. Tap "Start Your Journey"
5. Confirm you're ready
6. Your countdown begins!
**Warning**: This action cannot be undone. Make sure you're ready to commit!
### Understanding the Display
**Days Remaining**: How many days until your countdown ends
**Progress Percentage**: How much time has passed
**Motivational Messages**:
- 0-10%: "Every great journey begins with a single step"
- 10-25%: "You're building momentum"
- 25-50%: "Halfway there!"
- 50-75%: "Amazing progress!"
- 75-90%: "Almost there!"
- 90-100%: "The final stretch!"
### Countdown States
**Not Started**: You haven't confirmed your bucket list yet
**Active**: Your countdown is running
**Completed**: Your 1356 days have ended
---
## Social Features
### Public vs Private Profile
**Public Profile**:
- Others can see your username and avatar
- Your achievements appear in the feed
- You can appear on leaderboards
- Others can follow you
**Private Profile**:
- Only you can see your profile
- Your achievements stay private
- You don't appear on leaderboards
- Others cannot follow you
### Following Users
1. Go to the Social tab
2. Browse the feed or search for users
3. Tap on a user's profile
4. Tap "Follow"
5. See their milestones in your feed
### Viewing the Feed
The social feed shows:
- Public milestones from users you follow
- Achievement celebrations
- Goal completions
- Progress updates
### Leaderboards
Compete with others on:
- **Goals Completed**: Most goals finished
- **Active Streak**: Longest current streak
- **Recent Milestones**: Most recent achievements
### Achievements
Unlock badges for:
- **First Goal**: Complete your first goal
- **5 Goals**: Complete 5 goals
- **10 Goals**: Complete 10 goals
- **All Goals**: Complete all goals
- **Early Bird**: Start countdown in first week
- **Consistent**: Update goals 7 days in a row
- **Social Butterfly**: Follow 10 users
- **Influencer**: Get 10 followers
---
## Analytics & Insights
### Accessing Insights
1. Tap the "Insights" tab
2. View your progress visualization
### Available Charts
**Progress vs Time**
See how your progress has changed over time
**Goal Completion Trends**
Track which goals you complete fastest
**Streak Visualization**
View your consistency and momentum
**Summary Cards**
Quick stats:
- Total goals
- Completed goals
- Average progress
- Active streak
### Using Insights
- **Identify Patterns**: See when you're most productive
- **Stay Motivated**: Visual proof of your progress
- **Plan Ahead**: Use trends to set realistic goals
- **Celebrate Wins**: Acknowledge your achievements
---
## Settings & Customization
### Accessing Settings
1. Tap the "Profile" tab
2. Tap the settings icon
### Account Settings
**Edit Profile**
- Update username
- Change avatar
- Modify bio
**Email**
- View your email address
- Change email (if needed)
**Change Password**
- Update your password
- Requires current password
### Preferences
**Appearance**
- **Theme**: Light, Dark, or System
- **Time Format**: 12-hour or 24-hour
**Notifications**
- **Daily Reminders**: Get daily motivation
- **Weekly Summaries**: Weekly progress reports
- **Milestone Alerts**: Celebrate achievements
- **Countdown Checkpoints**: 50%, 25% remaining alerts
### Privacy Settings
**Profile Visibility**
- Toggle between Public and Private
**Blocked Users**
- Manage users you've blocked
### About
**About the Challenge**
- Learn more about the 1356-day concept
**Terms of Service**
- Read our terms and conditions
**Privacy Policy**
- Understand how we handle your data
### Account Deletion
**Important**: Deleting your account permanently removes all data.
1. Go to Settings
2. Scroll to "Danger Zone"
3. Tap "Delete Account"
4. Confirm via email
5. All data is permanently deleted
---
## Tips for Success
### Getting Started
1. **Start Small**: Begin with 5-10 goals, not the full 20
2. **Be Realistic**: Set achievable goals
3. **Mix It Up**: Include different types of goals (career, health, hobbies)
4. **Add Deadlines**: Give yourself timeframes
5. **Make It Personal**: Choose goals that matter to you
### Staying Motivated
1. **Check Daily**: Open the app every day to see your countdown
2. **Update Progress**: Regular updates keep you engaged
3. **Celebrate Wins**: Mark milestones as you complete them
4. **Join the Community**: Follow others for inspiration
5. **Use Images**: Add photos to stay inspired
### Overcoming Challenges
**Feeling Overwhelmed?**
- Focus on one goal at a time
- Break big goals into smaller steps
- Remember: progress, not perfection
**Lost Motivation?**
- Review your "why" for each goal
- Connect with the community
- Take a break, but don't quit
**Behind Schedule?**
- Don't panic - 1356 days is a long time
- Adjust your approach if needed
- Focus on progress, not perfection
### Best Practices
**Daily Routine**
- Open LifeTimer each morning
- Update at least one goal
- Read your motivational message
- Plan your day's actions
**Weekly Routine**
- Review all goals
- Update progress on multiple goals
- Check the social feed
- Celebrate weekly wins
**Monthly Routine**
- Review your insights
- Adjust goals if needed
- Plan next month's focus
- Reflect on your journey
---
## Troubleshooting
### Common Issues
**Countdown Not Updating**
- Ensure you have an internet connection
- Close and reopen the app
- Check for app updates
**Can't Start Countdown**
- Make sure you have at least 1 goal
- Check that all goals have titles
- Try refreshing the goals list
**Notifications Not Working**
- Check notification permissions
- Verify notification settings
- Ensure app is allowed in background
**Images Not Loading**
- Check your internet connection
- Try a different image source
- Clear app cache in settings
### Getting Help
**In-App Support**
- Settings > Send Feedback
- Describe your issue
- Include screenshots if helpful
**Email Support**
- support@lifetimer.app
- Include your username
- Describe the issue in detail
**Community**
- Discord server
- Social media (@LifeTimerApp)
- Check FAQ for common questions
---
## FAQ
See our [FAQ](FAQ.md) for answers to frequently asked questions.
---
## Privacy & Security
### Your Data
- Your data is encrypted and secure
- Only you can access your private data
- Public profiles show limited information
- You can delete your data anytime
### Account Security
- Use a strong, unique password
- Enable two-factor authentication (coming soon)
- Don't share your login credentials
- Log out from shared devices
### Privacy Settings
- Choose public or private profile
- Control what others can see
- Block unwanted users
- Delete your account anytime
---
## Contact Us
- **Email**: support@lifetimer.app
- **Twitter**: @LifeTimerApp
- **Discord**: https://discord.gg/lifetimer
- **Website**: https://lifetimer.app
---
**Version**: 1.0.0
**Last Updated**: January 3, 2026
Good luck on your 1356-day journey! 🚀