From d152edd722afc8cc7ce719641b01d1a359d994fb Mon Sep 17 00:00:00 2001 From: Dustin Kroeger Date: Sat, 23 Mar 2024 14:09:21 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=A6=20NEW:=20Add=20MIT=20License=20and?= =?UTF-8?q?=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE | 21 ++++++++++++++++++ README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0cb1f1a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 aottr + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d1619c --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# paw - Ticket System + +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![Python Version](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/) +Buy Me a Coffee at ko-fi.com + +🚀 paw is a comprehensive and open source ticket management system designed to streamline issue tracking and resolution processes for organizations. It provides a centralized platform for users to submit, track, and manage tickets or requests, facilitating efficient communication and collaboration among team members. + +## Features + +- **Ticket Creation and Submission:** Users can create and submit tickets with detailed information about the issue, including title, description, priority, and category and file attachments. + +- **Ticket Assignment and Ownership:** Tickets can be assigned to specific individuals or teams responsible for resolution, allowing for clear ownership and accountability. + +- **Communication and Collaboration:** Threaded communication enables seamless collaboration among team members, with the ability to add (internal) comments, attachments, and updates to tickets. + +- **Security and Access Control:** Secure user authentication, access controls, and audit trails ensure data privacy and compliance with organizational policies and regulations. You can create teams and restrict access of ticket categories to them. + +## Installation + +### As a Developer + +1. Clone the repository: + +```bash +git clone https://github.com/aottr/paw.git +``` + +2. Install dependencies: + +```bash +poetry install +``` + +3. Configure settings: + Copy `.env.example` to `.env` and update the configuration variables as needed. + +4. Run migrations: + +```bash +poetry run python manage.py migrate +``` + +5. Start the development server: + +```bash +poetry run python manage.py runserver +``` + +### Docker / OCI Container + +The Project contains a [Dockerfile](Dockerfile) that can be built locally or in a pipeline. I also provide the latest state of the `main` branch as an image + +## Usage + +- Access the application through `http://localhost:8000`. +- Register an account or log in with existing credentials. +- Start creating and managing tickets based on your role and permissions. + +## Contributing + +🙌 Contributions are welcome! Please follow the [guidelines](CONTRIBUTING.md). + +## License + +This project is licensed under the [MIT License](LICENSE). -- 2.51.2