extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-03-04 18:22:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor enhancement to indicate how to get hrlpdesk setup for development

Browse Source
This commit is contained in:
Christopher Broderick 2023-07-23 06:23:06 +01:00
parent f7381d5b62
commit f1e1d52cd2
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -51,7 +51,7 @@ Installation
`django-helpdesk` requires: `django-helpdesk` requires:
* Python 3.8+ * Python 3.8+
* Django 3.2 LTS highly recommended (early adopters may test Django 4) * Django 3.2 LTS or Django 4.*
You can quickly install the latest stable version of `django-helpdesk` You can quickly install the latest stable version of `django-helpdesk`
app via `pip`:: app via `pip`::
@ -72,6 +72,9 @@ Developer Environment
--------------------- ---------------------
Follow these steps to set up your development environment to contribute to helpdesk: Follow these steps to set up your development environment to contribute to helpdesk:
- check out the helpdesk app to you local file system::
git clone https://github.com/django-helpdesk/django-helpdesk.git
- install a virtual environment - install a virtual environment
- using virtualenv from the helpdesk base folder do:: - using virtualenv from the helpdesk base folder do::
virtualenv .venv && source .venv/bin/activate virtualenv .venv && source .venv/bin/activate
@ -79,6 +82,9 @@ Follow these steps to set up your development environment to contribute to helpd
- install the requirements for development:: - install the requirements for development::
pip install -r requirements.txt -r requirements-dev.txt pip install -r requirements.txt -r requirements-dev.txt
To reactivate a VENV just run:
source .venv/bin/activate
To see option for the Makefile run: `make` To see option for the Makefile run: `make`
The project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run:: The project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run::