Helldragon67
0c9b829c3f
Some checks failed
Build and deploy the backend to staging / Build and push image (pull_request) Successful in 2m2s
Run linting on the backend code / Build (pull_request) Successful in 29s
Run testing on the backend code / Build (pull_request) Failing after 4m29s
Build and deploy the backend to staging / Deploy to staging (pull_request) Successful in 25s
57 lines
2.8 KiB
Markdown
57 lines
2.8 KiB
Markdown
# Backend
|
|
|
|
This repository contains the backend code for the application. It utilizes **FastAPI** to quickly create a RESTful API that exposes the endpoints of the route optimizer.
|
|
|
|
## Getting Started
|
|
|
|
### Directory Structure
|
|
- 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.
|
|
|
|
### Setting Up the Development Environment
|
|
|
|
To set up your development environment using **pipenv**, follow these steps:
|
|
|
|
1. Install `pipenv` by running:
|
|
```bash
|
|
sudo apt install pipenv
|
|
```
|
|
|
|
2. Create and activate a virtual environment:
|
|
```bash
|
|
pipenv shell
|
|
```
|
|
|
|
3. Install the dependencies listed in the `Pipfile`:
|
|
```bash
|
|
pipenv install
|
|
```
|
|
|
|
4. The virtual environment will be created under:
|
|
```bash
|
|
~/.local/share/virtualenvs/...
|
|
```
|
|
|
|
### Deployment
|
|
To deploy the backend docker container, we use kubernetes. Modifications to the backend are automatically pushed to a two-stage environment through the CI pipeline. See [deployment/README](deployment/README.md] for further information.
|
|
|
|
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
|
|
|
|
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
|