Gas Utility Customer Service System

A Django-based customer service system for gas utility companies that allows customers to submit and track service requests online.

Features

• User authentication and authorization
• Service request submission and tracking
• File attachments for service requests
• Comments and internal notes
• Status updates and notifications
• RESTful API for integration
• Responsive web interface

Requirements

• Python 3.8+
• Django 5.2+
• Other dependencies listed in requirements.txt

Installation

1. Clone the repository:

git clone <repository-url>
cd gas-utility

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Set up environment variables:

cp .env.example .env
# Edit .env with your configuration

5. Run migrations:

python manage.py migrate

6. Create a superuser:

python manage.py createsuperuser

7. Run the development server:

python manage.py runserver

Usage

1. Access the admin interface at /admin to manage users and service requests
2. Customers can register and log in at /accounts/login
3. Submit new service requests at /create
4. View and track service requests at /
5. API documentation available at /api/

API Endpoints

• GET /api/requests/ - List all service requests
• POST /api/requests/ - Create a new service request
• GET /api/requests/{id}/ - Get service request details
• PUT /api/requests/{id}/ - Update a service request
• POST /api/requests/{id}/add_comment/ - Add a comment
• POST /api/requests/{id}/add_attachment/ - Add an attachment
• POST /api/requests/{id}/update_status/ - Update request status

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.