From f39d02f967a5870300d0b47319a2eca0c3a4a1ac Mon Sep 17 00:00:00 2001 From: Helldragon67 Date: Tue, 29 Oct 2024 12:14:12 +0100 Subject: [PATCH] better readme setup backend --- backend/README.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/backend/README.md b/backend/README.md index 1def675..7c30ebb 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,12 +1,37 @@ # 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. - +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 -- 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. + +### 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.