add readmes with first pointers
This commit is contained in:
16
backend/README.md
Normal file
16
backend/README.md
Normal file
@@ -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
|
Reference in New Issue
Block a user