User Documentation
User Documentation
GlucoQuest User Documentation
Table of Contents
Overview
GlucoQuest is an interactive web application designed to educate users about diabetes management through engaging tools and games. The platform combines health risk assessment with gamified learning experiences.
Getting Started
Accessing the Website
- Open any modern web browser (Chrome, Firefox, Safari, Edge)
- Navigate to: https://open-coding-society.github.io/glucoquest_frontend/
- No installation required - runs directly in your browser
Account Creation
- Click “Login” in the top right corner
- For first-time users:
- Select “Sign Up”
- Enter your:
- Full name
- GitHub ID
- Secure password (minimum 8 characters)
- Return to login with your credentials
- Start exploring GlucoQuest!
Main Features
Diabetes Risk Predictor
- Submit basic health information including:
- Age, weight, and family history
- Lifestyle factors
- Current health metrics
- Receive instant diabetes risk assessment
- View personalized percentage risk score
- Get actionable health recommendations
GlucoQuest Grand Prix
- Interactive racing game with diabetes education:
- Control your character through various tracks
- Collect healthy power-ups
- Avoid items that spike glucose levels
- Learn about carb counting and insulin management
- Multiple difficulty levels
- Progress tracking and achievement system
Pin the Dexcom
- Interactive onboarding tool for Dexcom CGM technology:
- Step-by-step CGM application simulator
- Troubleshooting common issues
- Understanding glucose readings
- Proper sensor placement guide
- Visual demonstrations with 3D models
- Quiz mode to test your knowledge
Documentation
For technical details and implementation information:
Jupyter Notebooks
Explore our collection of Jupyter notebooks that document each feature’s development:
- Diabetes Risk Predictor:
- Algorithm documentation
- API endpoints
- Machine learning model details
- GlucoQuest Grand Prix:
- Game mechanics
- Physics engine
- Educational content integration
- Pin the Dexcom:
- CGM simulation logic
- Educational content pipeline
- User interaction patterns
Access notebooks in our GitHub repository under the /notebooks
directory.
API Documentation
- RESTful API endpoints
- Request/response examples
- Authentication methods
Contribution Guidelines
- Code style standards
- Pull request process
- Issue reporting