Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jhonyes04/new-wayfy/llms.txt

Use this file to discover all available pages before exploring further.

WayFy is a full-stack travel platform built around one mission: making travel accessible for everyone. It combines an interactive Mapbox-powered map loaded with OpenStreetMap wheelchair data, an AI assistant for natural-language place discovery, and a community-driven review system — all in one place.

Introduction

Learn what WayFy is, how it works, and what problems it solves for travelers with reduced mobility.

Quickstart

Set up the full WayFy stack locally — frontend and backend — in under 10 minutes.

API Reference

Explore every REST endpoint: users, trips, accessibility reviews, AI, and community places.

Deployment

Deploy WayFy to Render with a PostgreSQL database and Cloudinary image hosting.

Core Features

Accessibility Map

Interactive Mapbox map with OSM wheelchair tags and community-validated place pins.

Trip Planner

Build day-by-day itineraries with maps, time slots, notes, and public sharing.

Place Discovery

Search hotels, restaurants, transports, and entertainment — filtered by accessibility level.

AI Assistant

Natural-language search powered by Groq and Llama 3.3 — ask for accessible places in plain text.

Community Reviews

Crowd-sourced accessibility reviews with feature flags, photos, and wheelchair ratings.

Architecture

React 18 + Vite frontend, Python Flask API, SQLAlchemy ORM, and JWT auth.

Get Running in 3 Steps

1

Clone and configure

Clone the repository, copy .env.example to .env in both frontend/ and backend/, and fill in your DATABASE_URL, JWT_SECRET_KEY, VITE_MAPBOX_TOKEN, and GROQ_API_KEY.
2

Start the backend

From backend/, run pipenv install then pipenv run upgrade to apply migrations, and pipenv run start to start Flask on port 3001.
3

Start the frontend

From frontend/, run pnpm install then npm run dev to start the Vite dev server on port 3000.
See the Quickstart guide for a complete walkthrough including environment variable setup, database configuration, and test data seeding.

Build docs developers (and LLMs) love