Package: django-helpdesk
Copyright 2009-2023 Ross Poulton and django-helpdesk contributors. All Rights Reserved.
See LICENSE for details.django-helpdesk was formerly known as Jutda Helpdesk, named after the
company which originally created it. As of January 2011 the name has been
changed to reflect what it really is: a Django-powered ticket tracker with
contributors reaching far beyond Jutda.Complete documentation is available in the docs/ directory,
or online athttp://django-helpdesk.readthedocs.org/.Demo Quickstartdjango-helpdeskincludes a basic demo Django project so that you may easily
get started with testing or developingdjango-helpdesk. The demo project
resides in thedemo/top-level folder.It’s likely that you can start up a demo project server by running
only the command:make rundemoor with docker:docker build . -t demodesk
docker run –rm -v “$PWD:/app” -p 8080:8080 demodeskthen pointing your web browser athttp://localhost:8080(log in as useradmin`with passwordTest1234).For more information and options, please read thedemo/README.rstfile.NOTE REGARDING SQLITE AND SEARCHING:The demo project usessqliteas its database. Sqlite does not allow
case-insensitive searches and so the search function may not work as
effectively as it would on other database such as PostgreSQL or MySQL
that does support case-insensitive searches.
For more information, see thisnotein the Django documentation.When you try to do a keyword search usingsqlite, a message will be displayed
to alert you to this shortcoming. There is no way around it, sorry.InstallationForstandaloneinstallation, refer tostandalone documentation.Tointegratewith an existing Django application, follow the guidelines ininstallation documentationandconfiguration documentation.Developer EnvironmentFollow these steps to set up your development environment to contribute to helpdesk:check out the helpdesk app to your local file system::git clonehttps://github.com/django-helpdesk/django-helpdesk.gitinstall a virtual environmentusing virtualenv from the helpdesk base folder do::virtualenv .venv && source .venv/bin/activateinstall the requirements for development::pip install -r requirements.txt -r requirements-dev.txtinstall the requirements for testing as well::pip install -r requirements.txt -r requirements-dev.txt -r requirements-testing.txtTo reactivate a VENV just run:source .venv/bin/activateTo see option for the Makefile run:makeThe project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run::make checkformatTo auto format any code use this::make formatTestingFrom the command line you can run the tests using:make testSeequicktest.pyfor usage details.Upgrading from previous versionsIf you are upgrading from a previous version ofdjango-helpdeskthat used
migrations, get an up to date version of the code base (eg by usinggit pullorpip install –upgrade django-helpdesk) then migrate the database:python manage.py migrate helpdesk --db-dry-run # DB untouched
python manage.py migrate helpdeskLastly, restart your web server software (eg Apache) or FastCGI instance, to
ensure the latest changes are in use.Unfortunately we are unable to assist if you are upgrading from a
version ofdjango-helpdeskprior to migrations (ie pre-2011).You can continue to the ‘Initial Configuration’ area, if needed.ContributingWe’re happy to include any type of contribution! This can be:back-end python/django code developmentfront-end web development (HTML/Javascript, especially jQuery)language translationswriting improved documentation and demosFor more information on contributing, please see theCONTRIBUTING.rstfile.Licensingdjango-helpdesk is licensed under terms of the BSD 3-clause license.
See theLICENSEfile for full licensing terms.Note that django-helpdesk is distributed with 3rd party products which
have their own licenses. See LICENSE.3RDPARTY for license terms for
included packages.