Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samuelschlesinger/ticket-management
A simple system for an individual managing tickets of work.
https://github.com/samuelschlesinger/ticket-management
Last synced: 20 days ago
JSON representation
A simple system for an individual managing tickets of work.
- Host: GitHub
- URL: https://github.com/samuelschlesinger/ticket-management
- Owner: SamuelSchlesinger
- License: mit
- Created: 2021-08-18T06:43:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-11T06:41:35.000Z (almost 3 years ago)
- Last Synced: 2024-10-27T19:10:39.789Z (2 months ago)
- Language: Haskell
- Size: 600 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ticket Management
A basic ticket management system for personal work. There is a web interface and a CLI
tool to manage it, though right now the CLI tool is much more fully featured.
# Usage
Here is the latest usage info:
```
Ticket Manager!
Usage: ticket-manager COMMAND
Allows the user to manage work tickets.
Available commands:
create Create a new ticket
edit Edit the name, description, and status of an existing
ticket
relate Relate one ticket to another
unrelate Remove the relationship between two tickets
query Search for tickets
init Initializes an empty ticket system
tag Applies some tags to tickets
validate Validate the ticket system
graphviz Output a dot formatted file describing a relation
graph
typescript Output typescript declarations for the servant API
```
Of special note is the help text for the query command:
```
Usage: ticket-manager query [(-n|--name ARG) | (-x|--tag ARG) | (-i|--id ARG) |
(-s|--status ARG) | (-b|--blocks ARG) |
(-s|--subsumes ARG) | (-p|--blocked-by ARG) |
(-k|--subsumed-by ARG)] [-o|--ordering ARG]
[-l|--limit ARG]
Search for tickets
```
This tool allows you to create tickets, specify relationships between them, tag them,
and then query them. To get all of the tickets you've tagged epic-1 and backend which
are not yet in progress, you can run the following:
```bash
ticket-manager query --tag epic-1 --tag backend --status todo
```
You can run instead:
```bash
ticket-manager query -x epic-1 -x backend -s todo
```
To create a ticket, we can run:
```bash
ticket-manager create my_first_ticket --name "The Best Ticket" --description "This ticket truly is the best" --status todo
```
You can run instead:
```bash
ticket-manager create my_first_ticket -n "The Best Ticket" -d "This ticket truly is the best" -s todo
```
With every command there is an associated `--help` command which I hope will help you learn how to use the rest of the commands.
The web interface is simply a slightly limited interface to the query command for now, but I intend to expand it.
The one extra feature it has over the CLI is clicking a related ticket to jump to it, which would not be worth
its weight in the CLI.
# Installation
To install, make sure you have GHC and cabal installed. If you are on Windows, that means
installing the Haskell Platform via Chocolatey, or Stack through their website. If you are
on Mac or Linux, you can install them via ghcup, which is my preferred method. You also
must have yarn and npm installed, though for those I'm less familiar with the blest way of
installation.
Run `./install.sh`, and then you can execute `ticket-manager serve -p 3001`, and navigate to `http://localhost:3001`.
To add tickets, you must currently use the CLI.
# Contribution
PRs and feedback are welcome, though I am aware this tool is missing several notable features that
today's ticket management systems have like dates, assignment, and lots of other things. These
things are left out on purpose, as it is meant to be a simplified version for individuals to use,
most notably myself.