diff --git a/backend/README.md b/backend/README.md index 7c30ebb..0278fe7 100644 --- a/backend/README.md +++ b/backend/README.md @@ -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: -1. Install `pipenv` by running: +1. Install `pipenv` on your machine by running: ```bash sudo apt install pipenv ``` 2. Create and activate a virtual environment: ```bash + cd backend/ pipenv shell ``` @@ -33,6 +34,13 @@ To set up your development environment using **pipenv**, follow these steps: ~/.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 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.