-
Notifications
You must be signed in to change notification settings - Fork 0
Quick Start
Ihab Saloum edited this page Jan 9, 2026
·
1 revision
Get up and running with StepSyncAI in less than 5 minutes!
Visit https://isaloum.github.io/StepSyncAI in any modern web browser:
- ✅ Chrome/Edge (recommended)
- ✅ Firefox
- ✅ Safari
- ✅ Opera
- ✅ Brave
On first visit, you'll see a welcome screen:
- Enter your name (optional - for personalization)
- Click "Continue"
- You're ready to start tracking!
Navigate using the tabs at the top (or bottom on mobile):
- 📊 Dashboard - View your wellness overview
- 🧠 Mental Health - Log mood and symptoms
- 💊 Medication - Add and track medications
- 😴 Sleep - Log sleep hours and quality
- 🏃 Exercise - Track physical activity
- 🚀 Faster loading with offline caching
- 📱 Native app feel on mobile and desktop
- 🔔 Future push notifications (coming soon)
- 💾 Better persistence of your data
- Visit https://isaloum.github.io/StepSyncAI
- Look for the install button (➕ icon) in the address bar
- Click "Install StepSyncAI"
- App will open in a standalone window
- Optionally pin to taskbar/dock
OR
- Click the three-dot menu (⋮)
- Select "Install StepSyncAI..."
- Click "Install"
- Visit https://isaloum.github.io/StepSyncAI
- Click File → Add to Dock
- App will appear in your Applications folder
- Open in Safari browser
- Tap the Share button (⬆️ icon at bottom)
- Scroll and tap "Add to Home Screen"
- Tap "Add"
- App icon will appear on your home screen
- Open in Chrome browser
- Tap the three-dot menu (⋮)
- Tap "Add to Home screen"
- Or tap the popup banner that appears
- App icon will appear on your home screen
Click the theme toggle button (🌙/☀️) in the top-right to switch between dark and light modes.
Your preference is saved automatically.
If you take medications:
- Go to 💊 Medication tab
- Enter medication name (e.g., "Vitamin D")
- Enter dosage (e.g., "1000 IU")
- Select time of day
- Click "Add Medication"
StepSyncAI will:
- ✅ Validate dosage for safety
- ✅ Check for drug interactions
- ✅ Allow you to track adherence daily
- Go to 🧠 Mental Health tab
- Move the slider to rate your mood (1-10)
- Select any symptoms (anxiety, stress, fatigue, etc.)
- Optionally add notes
- Click "Save Mood Entry"
- Go to 😴 Sleep tab
- Enter your bedtime (e.g., 10:00 PM)
- Enter wake time (e.g., 6:00 AM)
- Rate sleep quality (1-10)
- Click "Save Sleep Entry"
Return to the 📊 Dashboard to see:
- Your wellness score (updates as you log data)
- Today's stats (mood, sleep, exercise, medications)
- 7-day trends chart
- Personalized insights
- Activity streak
- Open StepSyncAI
- Log yesterday's sleep (bedtime → wake time)
- Mark morning medications as taken
- Check dashboard for insights
- Log today's mood
- Log any exercise
- Mark evening medications as taken
- Review wellness score
- Set a daily reminder on your phone
- Log data at the same time each day for patterns
- Don't skip days - even logging "no exercise" is valuable data
- Start with just mood tracking for the first week
- Add one new tracker per week
- Don't pressure yourself to track everything perfectly
- Every Sunday, check your 7-day trends chart
- Identify patterns (e.g., "I sleep worse on weekends")
- Adjust habits based on insights
- Export monthly as a backup (Dashboard → Export Data)
- Share with healthcare providers during appointments
- Keep historical records for long-term analysis
- Your data is 100% local (never sent to servers)
- Use the Sign Out button to clear all data
- Be cautious if using a shared/public device
- Tab - Navigate between form fields
- Enter - Submit forms or activate buttons
- Space - Toggle buttons
- Arrow Keys - Adjust sliders
All features are fully keyboard accessible for users who can't use a mouse.
On mobile devices (< 768px width), navigation moves to the bottom for easier thumb access.
- Swipe left/right to switch tabs
- Pull down to refresh dashboard
If you haven't installed the app, a "📲 Install App" button will appear in the bottom-right corner.
- Check browser localStorage is enabled
- Disable private/incognito mode (data won't persist)
- Clear browser cache and reload
- Check storage quota (should be 5MB+)
- Check internet connection (required for first load)
- Try a different browser
- Clear cache and reload
- Disable browser extensions that might interfere
- Log at least 2 days of data to see trends
- Refresh the page if chart doesn't appear
- Check browser console for JavaScript errors
- Already installed? Check your apps/home screen
- Using Safari on iOS? Use the Share → Add to Home Screen method instead
- Using Firefox? PWA install support is limited; use Chrome/Edge
If you accidentally signed out or cleared data:
- ❌ Unfortunately, data cannot be recovered (it's stored locally only)
- ✅ Export data regularly to prevent loss
- ✅ Consider syncing exports to cloud storage (Google Drive, Dropbox, etc.)
- 💬 GitHub Discussions: https://github.com/Isaloum/StepSyncAI/discussions
- 🐛 Report Bugs: https://github.com/Isaloum/StepSyncAI/issues
- 📚 Wiki Home: Home
- ❓ FAQ: Frequently Asked Questions
- 🏗️ Architecture: Technical Details
- ❌ Do not use it to diagnose or treat medical conditions
- ❌ Do not rely on it for critical medication reminders
- ✅ Always consult healthcare professionals for medical advice
- ✅ Use it as a supplement to, not replacement for, medical care
Now that you're set up, explore these features:
- View All Features - Learn what else StepSyncAI can do
- Read the FAQ - Common questions answered
- Explore the Dashboard - Understand your wellness score
- Check Security Practices - How your data is protected
- Star the Repo - Support the project ⭐
Happy tracking! 🎉
Your wellness journey starts today. Remember: consistency is more important than perfection.