anydev/anyway
anydev/anyway
0
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases Wiki Activity
anyway/README.md
Helldragon67 2f86536893 more readme
2025-01-23 17:57:17 +01:00

2.4 KiB
Raw Permalink Blame History

AnyWay - plan city trips your way

AnyWay is a mobile application that helps users plan city trips. The app allows users to specify their preferences and constraints, and then generates a personalized itinerary for them. The planning follows some guiding principles:

  • Personalization:The user's preferences should be reflected in the choice of destinations.
  • Efficiency:The itinerary should be optimized for the user's constraints.
  • Flexibility: We aknowledge that tourism is a dynamic activity, and that users may want to change their plans on the go.
  • Discoverability: Tourism is an inherently exploratory activity. Once a rough itinerary is generated, detours and spontaneous decisions should be encouraged.

Architecture

This project is divided into two main components: a frontend and a backend. The frontend is a Flutter application that runs on Android and iOS. The backend is a python server that runs on a cloud provider. The two components communicate via a REST API. Since both components are very interdependent and share many data structures, we opted for a monorepo approach.

Frontend

See the frontend README for more information. The application is centered around its map view, which displays the user's itinerary. This is based on the Google Maps API.

Backend

See the backend README for more information. The backend is responsible for generating the itinerary based on the user's preferences and constraints. Rather than using google maps, we use the OpenStreetMap database through the Overpass API, which is much more flexible.

Getting Started

Refer to the READMEs in the frontend and backend directories for instructions on how to run the application locally. Notable prerequisites include:

  • Flutter SDK
    • google_maps_flutter plugin
  • Python 3
    • fastapi
    • numpy
    • pydantic
  • Docker

Releases

The project is still in its early stages. We are currently working on a prototype that demonstrates the core functionality of the application.

Official releases will be made available on the Google Play Store and the Apple App Store.

Roadmap

See the project board: