add readmes with first pointers

README.md

@@ -1,16 +1,40 @@
-# fast_network_navigation
+# 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](frontend/README.md) 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](backend/README.md) 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 API, which is much more flexible.
 
-A new Flutter project.
 
 ## 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`
+    - `OSMPythonTools`
+    - `numpy, scipy`
+- Docker
 
-This project is a starting point for a Flutter application.
 
-A few resources to get you started if this is your first Flutter project:
+## Releases
+The project is still in its early stages. We are currently working on a prototype that demonstrates the core functionality of the application.
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+Official releases will be made available on the Google Play Store and the Apple App Store.
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+
+## Roadmap
+See the [project board](https://todos.kluster.moll.re/share/L8vZJGU45Vx9RzzVqTzyCPrpRybXm1OAqaW7YkWb/auth?view=list):
+<iframe src="https://todos.kluster.moll.re/share/L8vZJGU45Vx9RzzVqTzyCPrpRybXm1OAqaW7YkWb/auth?view=list" title="Todos" width="100%">

backend/README.md

@@ -0,0 +1,16 @@
+# Backend
+
+This repository contains the backend code for the application. It utilizes FastAPI that allows to quickly create a RESTful API that exposes the endpoints of the route optimizer.
+
+
+## Getting Started
+- The code of the python application is located in the `src` directory.
+- Package management is handled with `pipenv` and the dependencies are listed in the `Pipfile`.
+- Since the application is aimed to be deployed in a container, the `Dockerfile` is provided to build the image.
+
+### Deployment
+To deploy the backend docker container, we use kubernetes. The deployment configuration is located under [https://git.kluster.moll.re/anydev/deployment-backend/](https://git.kluster.moll.re/anydev/deployment-backend/).
+
+
+## Development
+TBD

frontend/README.md

@@ -0,0 +1,17 @@
+# Frontend
+
+This is the frontend of the project. It is a Flutter application that is designed to run on both Android and iOS devices. The frontend is responsible for displaying the user interface and handling user input. It communicates with the backend to retrieve and send data.
+
+
+## Getting Started
+The flutter application is divided into multiple chunks of code.
+- the `lib` directory contains the main code of the application.
+- the `android` and `ios` directories contain platform-specific code.
+- the root directory contains configuration files and metadata.
+
+To run the application, you need to have the Flutter SDK installed. You can find instructions on how to do this [here](https://flutter.dev/docs/get-started/install).
+
+Once you have the Flutter SDK installed, you can locally install the dependencies by running:
+```bash
+flutter pub get
+```