NOMAD
Navigation Organizer for Maps, Activities & Destinations

License: AGPL v3 Docker Pulls GitHub Stars Last Commit

A self-hosted, real-time collaborative travel planner with interactive maps, budgets, packing lists, and more.
Live Demo — Try NOMAD without installing. Resets hourly.

![NOMAD Screenshot](docs/screenshot.png) ![NOMAD Screenshot 2](docs/screenshot-2.png)
More Screenshots | | | |---|---| | ![Plan Detail](docs/screenshot-plan-detail.png) | ![Bookings](docs/screenshot-bookings.png) | | ![Budget](docs/screenshot-budget.png) | ![Packing List](docs/screenshot-packing.png) | | ![Files](docs/screenshot-files.png) | |
## Features ### Trip Planning - **Drag & Drop Planner** — Organize places into day plans with reordering and cross-day moves - **Interactive Map** — Leaflet map with photo markers, clustering, route visualization, and customizable tile sources - **Place Search** — Search via Google Places (with photos, ratings, opening hours) or OpenStreetMap (free, no API key needed) - **Day Notes** — Add timestamped, icon-tagged notes to individual days with drag & drop reordering - **Route Optimization** — Auto-optimize place order and export to Google Maps - **Weather Forecasts** — 16-day forecasts via Open-Meteo (no API key needed) with historical climate averages as fallback ### Travel Management - **Reservations & Bookings** — Track flights, hotels, restaurants with status, confirmation numbers, and file attachments - **Budget Tracking** — Category-based expenses with pie chart, per-person/per-day splitting, and multi-currency support - **Packing Lists** — Categorized checklists with progress tracking, color coding, and smart suggestions - **Document Manager** — Attach documents, tickets, and PDFs to trips, places, or reservations (up to 50 MB per file) - **PDF Export** — Export complete trip plans as PDF with cover page, images, notes, and NOMAD branding ### Mobile & PWA - **Progressive Web App** — Install on iOS and Android directly from the browser, no App Store needed - **Offline Support** — Service Worker caches map tiles, API data, uploads, and static assets via Workbox - **Native App Feel** — Fullscreen standalone mode, custom app icon, themed status bar, and splash screen - **Touch Optimized** — Responsive design with mobile-specific layouts, touch-friendly controls, and safe area handling ### Collaboration - **Real-Time Sync** — Plan together via WebSocket — changes appear instantly across all connected users - **Multi-User** — Invite members to collaborate on shared trips with role-based access - **Single Sign-On (OIDC)** — Login with Google, Apple, Authentik, Keycloak, or any OIDC provider ### Addons (modular, admin-toggleable) - **Vacay** — Personal vacation day planner with calendar view, public holidays (100+ countries), company holidays, user fusion with live sync, and carry-over tracking - **Atlas** — Interactive world map with visited countries, travel stats, continent breakdown, streak tracking, and liquid glass UI effects - **Dashboard Widgets** — Currency converter and timezone clock, toggleable per user ### Customization & Admin - **Dark Mode** — Full light and dark theme with dynamic status bar color matching - **Multilingual** — English and German (i18n) - **Admin Panel** — User management, global categories, addon management, API keys, backups, and GitHub release history - **Auto-Backups** — Scheduled backups with configurable interval and retention - **Customizable** — Temperature units, time format (12h/24h), map tile sources, default coordinates ## Tech Stack - **Backend**: Node.js 22 + Express + SQLite (`better-sqlite3`) - **Frontend**: React 18 + Vite + Tailwind CSS - **PWA**: vite-plugin-pwa + Workbox - **Real-Time**: WebSocket (`ws`) - **State**: Zustand - **Auth**: JWT + OIDC - **Maps**: Leaflet + react-leaflet-cluster + Google Places API (optional) - **Weather**: Open-Meteo API (free, no key required) - **Icons**: lucide-react ## Quick Start ```bash docker run -d -p 3000:3000 -v ./data:/app/data -v ./uploads:/app/uploads mauriceboe/nomad ``` The app runs on port `3000`. The first user to register becomes the admin. ### Install as App (PWA) NOMAD works as a Progressive Web App — no App Store needed: 1. Open your NOMAD instance in the browser (HTTPS required) 2. **iOS**: Share button → "Add to Home Screen" 3. **Android**: Menu → "Install app" or "Add to Home Screen" 4. NOMAD launches fullscreen with its own icon, just like a native app
Docker Compose (recommended for production) ```yaml services: app: image: mauriceboe/nomad:latest container_name: nomad ports: - "3000:3000" environment: - NODE_ENV=production - PORT=3000 volumes: - ./data:/app/data - ./uploads:/app/uploads restart: unless-stopped ``` ```bash docker compose up -d ```
### Updating ```bash docker pull mauriceboe/nomad docker rm -f nomad docker run -d --name nomad -p 3000:3000 -v /your/data:/app/data -v /your/uploads:/app/uploads --restart unless-stopped mauriceboe/nomad ``` Or with Docker Compose: `docker compose pull && docker compose up -d` Your data is persisted in the mounted `data` and `uploads` volumes. ### Reverse Proxy (recommended) For production, put NOMAD behind a reverse proxy with HTTPS (e.g. Nginx, Caddy, Traefik). > **Important:** NOMAD uses WebSockets for real-time sync. Your reverse proxy must support WebSocket upgrades on the `/ws` path.
Nginx ```nginx server { listen 80; server_name nomad.yourdomain.com; return 301 https://$host$request_uri; } server { listen 443 ssl http2; server_name nomad.yourdomain.com; ssl_certificate /path/to/fullchain.pem; ssl_certificate_key /path/to/privkey.pem; location /ws { proxy_pass http://localhost:3000; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_read_timeout 86400; } location / { proxy_pass http://localhost:3000; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } } ```
Caddy Caddy handles WebSocket upgrades automatically: ``` nomad.yourdomain.com { reverse_proxy localhost:3000 } ```
## Optional API Keys API keys are configured in the **Admin Panel** after login. Keys set by the admin are automatically shared with all users — no per-user configuration needed. ### Google Maps (Place Search & Photos) 1. Go to [Google Cloud Console](https://console.cloud.google.com/) 2. Create a project and enable the **Places API (New)** 3. Create an API key under Credentials 4. In NOMAD: Admin Panel → Settings → Google Maps ### OpenWeatherMap (Weather Forecasts) 1. Sign up at [OpenWeatherMap](https://openweathermap.org/api) 2. Get a free API key 3. In NOMAD: Admin Panel → Settings → OpenWeatherMap ## Building from Source ```bash git clone https://github.com/mauriceboe/NOMAD.git cd NOMAD docker build -t nomad . ``` ## Data & Backups - **Database**: SQLite, stored in `./data/travel.db` - **Uploads**: Stored in `./uploads/` - **Backups**: Create and restore via Admin Panel - **Auto-Backups**: Configurable schedule and retention in Admin Panel ## License [AGPL-3.0](LICENSE)