Skip to content

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

303 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

No Scratch Nav

Safe routes for big rigs. Zero scratches guaranteed.

Find trusted Google Maps routes tested by real drivers in tight city centers, narrow streets, low bridges, and complex environments.

⚠️ Important: This project strictly respects Google Maps Terms of Service. We store only user-submitted links and manual descriptions — no scraping, no API bypassing, no automatic parsing.


The Problem

Standard navigation apps (TomTom, Garmin, Google Maps default) often fail large vehicles (14m+ coaches) in:

  • Narrow historic city centers
  • Low bridge & height-restricted zones
  • Tight hotel, airport, and attraction approaches
  • Mountain roads with sharp turns

When you're driving a 14-metre coach through an old town, the safest route is one that another experienced driver has already successfully driven.


The Solution

A simple, driver-made platform where you can:

  • Share Google Maps route links that work for big buses
  • Browse routes shared by other professional drivers in your area
  • Post route requests (e.g. "Paris CDG → Gare du Nord for 14m coach")
  • Build personal multi-stop day plans using only trusted routes

Sign in to browse routes.
Free account required to share routes, reply to requests, or save trip plans.


Core Features

📍 Share Trusted Routes
Paste any Google Maps link (with waypoints) + title, description, country & city.
Can be standalone or a reply to a request.

🔍 Search & Browse
Filter by country, city, or keywords. See real-driver notes about suitability.

❓ Route Requests
Post what you need → community replies with working links.

⭐ Trust Signals
Upvotes, verified driver counts, and detailed route descriptions help you find routes that actually work.

🗺️ Trip Planner
Drag-and-drop multi-stop planning with Google Maps integration.

📱 Mobile Friendly
Access routes on the go from any device.


Tech Stack

Layer Technology
Frontend React + TypeScript + Material UI
Backend Node.js + Express
Database PostgreSQL
Cache Redis
Container Docker + Nginx

Quick Start (Docker)

# Clone the repo
git clone https://github.com/yourusername/no-scratch-nav.git
cd no-scratch-nav

# Start the app
docker compose up -d

# Access at http://localhost

Local development accounts (created by seed script — never used in production):

# .env — required for seeding
SEED_ADMIN_PASSWORD=$(openssl rand -base64 32)
SEED_TEST_PASSWORD=$(openssl rand -base64 32) # optional, dev only
node backend/scripts/seed-users.js

Seed script refuses to create the test@example.com account in NODE_ENV=production unless SEED_TEST_PASSWORD is explicitly set. Real deployments must use unique, rotated credentials — never default/common passwords.


Project Structure

no-scratch-nav/
├── backend/
│   ├── index.js           # Express app
│   ├── db.js              # Database + Redis
│   ├── middleware/        # Auth, admin, sanitize
│   ├── routes/            # API endpoints
│   ├── migrations/        # Database schema
│   ├── scripts/           # Import scripts
│   └── services/          # Email service
├── frontend/
│   ├── src/
│   │   ├── components/    # React components
│   │   ├── types/         # TypeScript types
│   │   ├── api.ts         # API client
│   │   ├── App.tsx        # Main app
│   │   └── theme.ts       # MUI theme
│   └── public/
├── docs/                  # Documentation
├── docker-compose.yml
├── Dockerfile.backend
├── Dockerfile.frontend
├── nginx.conf
├── backup-db.sh           # Database backup
├── restore-db.sh          # Database restore
└── startup.md             # Setup guide

Environment Variables

Variable Description Default
PORT Server port 5000
DATABASE_URL PostgreSQL connection (Docker internal)
REDIS_URL Redis connection (Docker internal)
JWT_SECRET Auth secret (change in prod)
RESEND_API_KEY Email service Optional
FROM_EMAIL Sender email noreply@...

Copy .env.example to .env and configure for production.


API Endpoints

Method Endpoint Description
GET /api/routes List/search routes
POST /api/routes Create route (auth)
GET /api/routes/:id Get single route
POST /api/routes/:id/upvote Upvote route
GET /api/requests List route requests
POST /api/requests Create request (auth)
POST /api/auth/register Register
POST /api/auth/login Login
POST /api/auth/logout Logout

Contributing

Contributions welcome! Please read the docs for guidelines.


License

AGPL-3.0 — see LICENSE for details.


Legal

This project is 100% compliant with Google Maps Terms of Service:

  • ✅ No scraping of Google Maps data
  • ✅ No API bypassing or rate limit abuse
  • ✅ Manual entry only (user-submitted links)
  • ✅ Users are responsible for their shared content

See docs/LEGAL.md for full details.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages