- Concise Description
- Overview
- Key Features and Benefits
- Target Audience
- Getting Started
- Architecture
- Development Workflow
- Available Scripts
- Project Structure
- Deployment
- Open Source License
Sure Walk is a mobile app and web project meant to allow for a seamless process of booking a Sure Walk to travel on-campus to off-campus. The app provides a user-friendly experience with additional relevant information about Sure Walks. The website provides an interface for UT Sure Walk Staff to query information in the database.
Sure Walk's current process of receiving requests and assigning drivers to students is inefficient and has much that can be improved upon. Students also have had varying experiences with arrival and wait estimation times.
Sure Walk aims to improve the processes of booking a Sure Walk through easier management of Sure Walk driver assignments and more elaborate and relevant information. Through an improved software system, students will be able to have more information about the rides they book and Sure Walk managers will be able to effectively manage all bookings and drivers.
- Guided onboarding paths for UT affiliated persons (students, staff) and guests
- Built with accessibility, responsiveness, and scalability in mind
- Students who live off-campus and travel within the hours of 8pm - 2am
- UT Sure Walk Staff
- Installations:
- pnpm
- Git
- Testing Prerequisites
git clone git@github.com:Longhorn-Developers/Sure-Walk.git
cd Sure-Walk
pnpm install
# Mobile (Expo)
cd apps/mobile
pnpm ios|android
# Web admin dashboard (Next.js)
cd apps/web
pnpm dev
- Expo
- React Native for front-end
- TypeScript
- Next.js
- Tailwind CSS for styling
- Drizzle as the ORM
- Cloudflare for deployment and hosting
-
User App (React Native with Expo)
- Provides UT students a mobile interface to request a Sure Walk, track their walk in real-time, and communicate with their assigned Sure Walk driver.
-
Dispatcher Dashboard (Web)
- Enables coordinators to oversee all walk requests, manually assign drivers if needed, and monitor real-time walk progress.
-
Authentication System
- (planned) Integrates with UT EID + Duo for secure user verification and driver permissions.
-
Real-Time Backend
- Handles Sure Walk requests and communicates with the Samsara API.
-
GPS and Location Services
- Tracks user and driver locations for real-time updates and routing.
-
Database
- Stores user profiles, walk history, driver logs, and route data.
-
Safety-first UX
- Prioritize clear visuals, status updates, and easy communication to reassure users throughout their walk.
-
Minimal friction
- Fast and simple request flow with default pickup locations, and persistent session state.
-
Privacy and data security
- No unnecessary location tracking or data retention. Authentication is scoped and session-based.
-
Real-time communication
- Users, and dispatchers receive updates in real-time.
-
Reliability and resilience
- App maintains state across reloads and can recover gracefully from connection drops.
We follow the Conventional Commits specification for commit messages. This ensures a consistent commit history and enables automated versioning and changelog generation.
<type>/<short-description>
Examples:
- feature/{feature-name}
- fix/{bug-description}
- docs/{documentation-change}
Follow this structure for commit messages
<type>(<scope>): <subject>
Where:
- feat: New features
- fix: Bug fixes
- docs: Documentation changes
- style: Code formatting only
- refactor: Code changes without behavior change
- test: Adding or updating tests
- chore: Build process or tooling updates
- web: changes in the web (Next.js) app
- mobile: changes in the mobile (Expo) app
- shared: changes to the common ui module
- Fork or branch from main
- Create a PR with a clear description
- Ensure checks pass (build, lint)
- Request review before merging
- Unit tests for UI components
- Integration tests for feature flows
We welcome all to contribute! Please carefully read our Contributing Guide and Code of Conduct before getting started. All contributors must adhere to our Code of Conduct
pnpm expo start# Start expo app, needs ios simulator or android simulator unless using web versionpnpm expo start -c# Starts expo app, clearing cache, run if loading slowlypnpm lint# Lint codebasepnpm format# Format code using Prettier
/
├── package.json
├── pnpm-workspace.yaml
├── apps/
│ ├── mobile/ # Expo React Native app
│ └── web/ # Next.js web dashboard
├── packages/
│ ├── ui/ # Shared UI components
│ └── utils/ # Common utils
└── types/ # Shared types
└── .gitignore
- pnpm-workspace.yaml - Defines the workspace structure
- apps/mobile/ - Contains the Expo-based React Native application for users and drivers
- apps/web/ - Contains the Next.js admin dashboard for Sure Walk staff
- packages/ui/ - Shared UI components that can be used in both mobile and web apps
- packages/utils/ - Common utility functions shared across the applications
- packages/utils/types/ - TypeScript types and interfaces used throughout the project
- Hosted on Cloudflare
- Push changes to GitHub
- CD workflow builds automatically from
mainbranch and deploys to Cloudflare
Usually MIT but choose as needed as some dependencies may require a different license