From 0c9b829c3fda7d38b3c58612e5976501c51d6a2e Mon Sep 17 00:00:00 2001 From: Helldragon67 Date: Thu, 23 Jan 2025 18:08:20 +0100 Subject: [PATCH] more stuff --- backend/README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/backend/README.md b/backend/README.md index 1ad7483..090f98b 100644 --- a/backend/README.md +++ b/backend/README.md @@ -5,7 +5,7 @@ This repository contains the backend code for the application. It utilizes **Fas ## Getting Started ### Directory Structure -- The code for the Python application is located in the `src` directory. For further information, refer to the [src README](backend/src/README.md). +- The code for 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 designed to be deployed in a container, the `Dockerfile` is provided to build the image. @@ -38,7 +38,19 @@ To deploy the backend docker container, we use kubernetes. Modifications to the The deployment configuration is included as a submodule in the `deployment` directory. The standalone repository is under [https://git.kluster.moll.re/anydev/anyway-backend-deployment/](https://git.kluster.moll.re/anydev/anyway-backend-deployment/). - ## Development -TBD +The backend application is structured around the `src` directory, which contains the core components for handling route optimization and API logic. Development generally involves working with key modules such as the optimization engine, Overpass API integration, and utilities for managing landmarks and trip data. + +### Key Areas: +- **API Endpoints**: The main interaction with the backend is through the endpoints defined in `src/main.py`. FastAPI simplifies the creation of RESTful services that manage trip and landmark data. +- **Optimization Logic**: The trip optimization and refinement are handled in the `src/optimization` module. This is where the core algorithms are implemented. +- **Landmark Management**: Fetching and prioritizing points of interest (POIs) based on user preferences happens in `src/utils/LandmarkManager`. +- **Testing**: The `src/tests` directory includes tests in various scenarii, ensuring that the logic works as expected. + +For detailed information, refer to the [src README](backend/src/README.md). + +### Running the Application: +To run the backend locally, ensure that the virtual environment is activated and all dependencies are installed as outlined in the "Getting Started" section. You can start the FastAPI server with: +```bash +uvicorn src.main:app --reload