anyway/backend/README.md
Remy Moll 9deb461925
All checks were successful
Build and deploy the backend to staging / Build and push image (pull_request) Successful in 1m43s
Build and deploy the backend to staging / Deploy to staging (pull_request) Successful in 13s
a bit of documentation
2024-09-21 15:10:48 +02:00

1016 B

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. 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/.

Development

TBD