OpenSTR/README.md

OpenSTR

Open Service Tracker Repair Tool, created as an internal tool for Miracle Computer Consulting, to track appointments and computer repairs for their business.

Features

• Front end for customer computer tracking
  • Display repairs and appointments using a customer's email address or username
  • Customer Appointment Scheduling
  • Sign forms and other paperwork
  • Track a computer's progress and see work notes
• Technician panel for computer repair tracking
  • Homepage with submitted, in queue, in progress, and completed devices
  • Repair Bay overview
  • Device Info Pages (includes device information, status, BitLocker information, username, password, device history, warranty information, etc.)
  • Customer/Consulting Appointment page
  • Repair Notes for devices, separated through issue tracking
• Administration panel
  • Allows for the administrator to create/remove repair bays, new users, etc.
  • Simple Authentication
  • OAuth2/LDAP/External Authentication Integration
  • Form and paperwork generation/editor (contains templates for forms/other paperwork to be filled out)
  • SQLite or full SQL Database support (switchable)
• Mailing for customer repairs and technician appointments
  • Uses SMTP and other information to send mail
• Self-hostable & Licensable
  • Self-hostable for personal/limited commercial use
  • Licensable for full commercial use
  • Dockerized for self-hosting

Setup Instructions

1. Clone the repository:

   git clone <repository-url>
   

2. Navigate to the project directory:

   cd OpenSTR
   

3. Install the required dependencies:

   pip install -r requirements.txt
   

4. Configure the application settings in config.py.
5. Run the application:

   python run.py
   

Usage

• Access the application through your web browser at http://localhost:5000.
• Use the customer, technician, and admin panels to manage repairs and appointments.