Update backend/README.md
All checks were successful
Build and deploy the backend to staging / Build and push image (pull_request) Successful in 2m12s
Build and deploy the backend to staging / Deploy to staging (pull_request) Successful in 14s

This commit is contained in:
Helldragon67 2024-11-05 14:45:47 +00:00
parent d94c69c545
commit d0e837377b

View File

@ -13,13 +13,14 @@ This repository contains the backend code for the application. It utilizes **Fas
To set up your development environment using **pipenv**, follow these steps: To set up your development environment using **pipenv**, follow these steps:
1. Install `pipenv` by running: 1. Install `pipenv` on your machine by running:
```bash ```bash
sudo apt install pipenv sudo apt install pipenv
``` ```
2. Create and activate a virtual environment: 2. Create and activate a virtual environment:
```bash ```bash
cd backend/
pipenv shell pipenv shell
``` ```
@ -33,6 +34,13 @@ To set up your development environment using **pipenv**, follow these steps:
~/.local/share/virtualenvs/... ~/.local/share/virtualenvs/...
``` ```
5. (Optional) To keep up with changes in the virtual environment, you need to update the required packages if changes occur :
```bash
pipenv install " to install required normal packages
pipenv install --dev # to install required dev packages
```
### Deployment ### 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. 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.