Skip to content

Jan0226/Roami

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Roami - Your Walking Companion

A mobile-first web application designed to enhance your walking experience with route planning, motivation, idea capture, and social features.

Features

🗺️ Route Planner

  • Input: Choose your preferred scenery (Forest, Urban, Neighborhood, or Mixed)
  • Input: Select time/duration (15 minutes to 1.5 hours)
  • Input: Set your target step count
  • Output: Get 3 personalized route recommendations with detailed information

🚶 Walking Session

  • Motivation Quotes: Inspirational quotes to keep you motivated during your walk
  • Idea Capture: Write down thoughts and ideas that come to mind while walking
  • Real-time Stats: Track steps, distance, and time during your session
  • Quote Refresh: Get new motivation quotes with a single tap

📝 Journal

  • Automatic Saving: Ideas captured during walks are automatically saved
  • Manual Entries: Create custom journal entries anytime
  • Filtering: Filter entries by type (walking ideas vs manual entries)
  • Persistent Storage: All entries are saved locally in your browser

🏆 Regional Leaderboard

  • Multiple Regions: View leaderboards for current region, city, state, or country
  • Step Tracking: See who's walking the most in your area
  • Ranking System: Gold, silver, and bronze rankings for top performers

Color Scheme

The app uses a carefully chosen color palette:

  • Primary Color: #23788b (Deep Teal)
  • Secondary Color: #468475 (Forest Green)
  • Tertiary Color: #9234b (Purple)

Technical Features

  • Mobile-First Design: Optimized for mobile devices with responsive layout
  • Progressive Web App: Works offline and can be installed on mobile devices
  • Local Storage: All data is stored locally in the browser
  • Smooth Animations: Engaging transitions and loading effects
  • Modern UI: Clean, intuitive interface with modern design principles

Getting Started

  1. Open the App: Simply open index.html in any modern web browser
  2. Loading Screen: The app starts with a beautiful loading animation
  3. Navigation: Use the bottom navigation to switch between features
  4. Route Planning: Start by planning your first route
  5. Start Walking: Use the walking screen during your walks
  6. Track Progress: Check the leaderboard to see how you compare

Usage Guide

Planning a Route

  1. Navigate to the "Routes" tab
  2. Select your preferred scenery type
  3. Choose your desired duration
  4. Enter your target step count
  5. Tap "Find Routes" to get recommendations

During Your Walk

  1. Switch to the "Walking" tab
  2. Read the motivation quote
  3. Tap "New Quote" for fresh inspiration
  4. Use the idea capture section to write down thoughts
  5. Watch your stats update in real-time

Managing Your Journal

  1. Go to the "Journal" tab
  2. View all your saved ideas and entries
  3. Use "New Entry" to create manual journal entries
  4. Use "Filter" to organize your entries by type

Checking Leaderboards

  1. Navigate to the "Leaderboard" tab
  2. Select your desired region from the dropdown
  3. View the top walkers in your area

Browser Compatibility

  • Chrome (recommended)
  • Firefox
  • Safari
  • Edge
  • Mobile browsers (iOS Safari, Chrome Mobile)

Local Development

To run the app locally:

  1. Clone or download the project files
  2. Ensure all files are in the same directory:
    • index.html
    • styles.css
    • script.js
  3. Open index.html in your web browser
  4. The app will load automatically

Data Storage

All app data is stored locally in your browser's localStorage:

  • Journal entries
  • Walking statistics
  • App preferences

This ensures your data remains private and accessible offline.

Future Enhancements

Potential features for future versions:

  • GPS route tracking
  • Social sharing
  • Achievement badges
  • Weather integration
  • Route sharing
  • Community features
  • Integration with fitness trackers

About Roami

Roami is designed to make walking more enjoyable and productive. Whether you're looking for inspiration, want to capture creative ideas, or enjoy some friendly competition, Roami has you covered.

Happy Walking! 🚶‍♀️🚶‍♂️

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors