From 8f59714d9fd3b5a7095876b3946f592cf79d49e8 Mon Sep 17 00:00:00 2001 From: Jared Vititoe Date: Wed, 1 Jan 2025 18:35:37 -0500 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd19663..c6e07c0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ -# tinker_tickets +# Tinker Tickets -JWS Ticketing System \ No newline at end of file +A lightweight PHP-based ticketing system designed for tracking and managing data center infrastructure issues. + +## Features + +- 📊 Clean dashboard interface with sortable columns +- 🎫 Customizable ticket creation and management +- 🔄 Real-time status updates and priority tracking +- 💬 Markdown-supported commenting system +- 🔔 Discord integration for notifications +- 📱 Mobile-responsive design + +## Core Components + +- **Dashboard**: View and filter tickets by status, priority, and type +- **Ticket Management**: Create, edit, and update ticket details +- **Priority Levels**: P1 (Critical) to P4 (Low) impact tracking +- **Categories**: Hardware, Software, Network, Security tracking +- **Comment System**: Markdown support for detailed documentation + +## Technical Details + +- Backend: PHP with MySQL database +- Frontend: HTML5, CSS3, JavaScript +- Authentication: Environment-based configuration +- API: RESTful endpoints for ticket operations + +## Configuration + +1. Create `.env` file with database credentials: +```env +DB_HOST=localhost +DB_USER=username +DB_PASS=password +DB_NAME=database +DISCORD_WEBHOOK_URL=your_webhook_url \ No newline at end of file