The suggested IDE is PyCharm for this project and the instructions will be given accordingly.
Please execute the following commands to clone the repository. If you are seeing this repository, it is assumed that you already have access to read and write. Hence, please provide credentials to clone the repo.
git clone [email protected]:pport-application/pport-Backend.git
The next, thing that needs to be done is to set the Python interpreter in PyCharm, so, venv's python will be utilized as well as other packages installed in the project's scope.
File | Settings | Project: pport-Backend | Python Interpreter for Windows and Linux
PyCharm | Preferences | Project: pport-Backend | Python Interpreter for macOS
Please add a new interpreter by clicking the setting icon and then add.
Inside Virtualenv Environment | New Environment add a new path which is /LOCATION/OF/YOUR/REPOSITORY/pport_Backend/venv
Close the Settings/Preferences page and go to Edit Configuration on the left side of run.
Script Path: /LOCATION/OF/YOUR/REPOSITORY/pport_Backend/manage.py
Parameters: runserver
Python Interpreter: /LOCATION/OF/YOUR/REPOSITORY/pport_Backend/venv
Now, you are ready to develop the project.
The project is encapsulated with venv, so, to install the package within the project's scope, please activate venv and then install the packages. The commands for activating venv are as follows.
cd pport-Backend
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
Please do not make changes in master branch. Create a new branch from developing and merge back when you are done.
A detailed explanation for the branches is given below.
