aottr.dev
Free and open source ticket system written in python
📦 NEW: Add MIT License and README
+21
LICENSE
+21
LICENSE
···
1
+
MIT License
2
+
3
+
Copyright (c) 2024 aottr
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+66
README.md
+66
README.md
···
1
+
# paw - Ticket System
2
+
3
+
[](LICENSE)
4
+
[](https://www.python.org/downloads/release/python-3120/)
5
+
<a href='https://ko-fi.com/alexottr' target='_blank'><img height='35' style='border:0px;height:24px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com'></a>
6
+
7
+
🚀 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.
8
+
9
+
## Features
10
+
11
+
- **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.
12
+
13
+
- **Ticket Assignment and Ownership:** Tickets can be assigned to specific individuals or teams responsible for resolution, allowing for clear ownership and accountability.
14
+
15
+
- **Communication and Collaboration:** Threaded communication enables seamless collaboration among team members, with the ability to add (internal) comments, attachments, and updates to tickets.
16
+
17
+
- **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.
18
+
19
+
## Installation
20
+
21
+
### As a Developer
22
+
23
+
1. Clone the repository:
24
+
25
+
```bash
26
+
git clone https://github.com/aottr/paw.git
27
+
```
28
+
29
+
2. Install dependencies:
30
+
31
+
```bash
32
+
poetry install
33
+
```
34
+
35
+
3. Configure settings:
36
+
Copy `.env.example` to `.env` and update the configuration variables as needed.
37
+
38
+
4. Run migrations:
39
+
40
+
```bash
41
+
poetry run python manage.py migrate
42
+
```
43
+
44
+
5. Start the development server:
45
+
46
+
```bash
47
+
poetry run python manage.py runserver
48
+
```
49
+
50
+
### Docker / OCI Container
51
+
52
+
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
53
+
54
+
## Usage
55
+
56
+
- Access the application through `http://localhost:8000`.
57
+
- Register an account or log in with existing credentials.
58
+
- Start creating and managing tickets based on your role and permissions.
59
+
60
+
## Contributing
61
+
62
+
🙌 Contributions are welcome! Please follow the [guidelines](CONTRIBUTING.md).
63
+
64
+
## License
65
+
66
+
This project is licensed under the [MIT License](LICENSE).