v1.0.0
Neuro-Nav App ๐ง ๐บ๏ธ
Neuro-Nav is a sensory-friendly navigation application designed to help neurodivergent individuals navigate cities with confidence. It prioritizes "quiet" routes, identifies safe havens, and provides tools for stress management.
๐ Features
- Quiet Routing: Uses OSRM to calculate routes that minimize sensory overload (noise, crowds).
- Safe Havens: Real-time discovery of quiet places (Libraries, Parks, Cafes) using OpenStreetMap data.
- Panic Mode: One-tap access to emergency contacts and calming tools.
- Community Reporting: Report sensory hazards (construction, loud events) to warn others.
- Trip History: Local storage of past trips for easy re-booking.
- Leaflet Maps: currently running on a WebView-based Leaflet Map (OpenStreetMap), requiring NO API Keys for display.
๐ ๏ธ Tech Stack
- Framework: React Native (Expo)
- Maps: Leaflet.js (WebView) + OpenStreetMap
- Routing: OSRM (Open Source Routing Machine)
- Storage: AsyncStorage (Local)
- Auth: Firebase (Mocked for Demo/MVP)
- Build: EAS (Expo Application Services)
๐ฆ Installation
-
Clone the repository:
git clone https://github.com/Dharaneesh20/Neuro-Nav-App.git cd neuro-nav-rn -
Install dependencies:
npm install
-
Run the app:
npx expo start
๐ Configuration (Optional)
๐ Map Configuration: Leaflet vs. Google Maps
Current Default: Open Source Leaflet Maps
The application is currently configured to use Leaflet Maps (WebView) with OpenStreetMap.
- No API Key Required: Works out of the box.
- Open Source: Uses free map data.
- Implementation: Located in
src/components/LeafletMap.js.
Optional: Switching to Google Maps SDK
If you prefer the performance and look of native Google Maps, you can switch the provider. Note: This requires an API Key and recompiling the app.
-
Get an API Key:
- Visit the Google Cloud Console.
- Enable "Maps SDK for Android".
- Create a credential (API Key).
-
Configure the App:
- Open
app.jsonand add your key underandroid.config.googleMaps.apiKey:"android": { "package": "com.dharaneeshrs007.neuronav", "config": { "googleMaps": { "apiKey": "PASTE_YOUR_API_KEY_HERE" } } }
- Open
-
Update Code:
- In
DashboardScreen.jsandRoutePlanningScreen.js, replaceLeafletMapwithMapView(Native).
- In
-
Important - Compile with Android Studio:
- Native Google Maps will not work in Expo Go if you use custom keys.
- You must compile a development build or APK using Android Studio or EAS Build.
๐ธ Demo
(Paste your YouTube video link above to replace the placeholder)
๐ค Contributing
- Fork the repo
- Create a feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
๐ค Author
Dharaneesh
- GitHub: @Dharaneesh20
- Email: dharaneeshrs777@gmail.com
