updated documentation and models (#64)

* updated documentation and models

* Added tests for newly added line

Author: adamspd

README.md

@@ -21,6 +21,9 @@ users to define custom configurations for time slots, lead time, and finish time
 provided. This app proficiently manages conflicts and availability for appointments, ensuring a seamless user
 experience.
 
+For a detailed walkthrough and live example of the system, please refer to 
+[this tutorial](https://github.com/adamspd/django-appointment/tree/main/docs/explanation.md).
+
 Detailed documentation can be found in
 the [docs' directory](https://github.com/adamspd/django-appointment/tree/main/docs/README.md).
 For changes and migration information, please refer to the [release

appointment/models.py

@@ -284,7 +284,7 @@ class AppointmentRequest(models.Model):
     start_time = models.TimeField()
     end_time = models.TimeField()
     service = models.ForeignKey(Service, on_delete=models.CASCADE)
-    staff_member = models.ForeignKey(StaffMember, on_delete=models.DO_NOTHING)
+    staff_member = models.ForeignKey(StaffMember, on_delete=models.SET_NULL, null=True)
     payment_type = models.CharField(max_length=4, choices=PAYMENT_TYPES, default='full')
     id_request = models.CharField(max_length=100, blank=True, null=True)
 
@@ -368,7 +368,7 @@ class Appointment(models.Model):
     Version: 1.1.0
     Since: 1.0.0
     """
-    client = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
+    client = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True)
     appointment_request = models.OneToOneField(AppointmentRequest, on_delete=models.CASCADE)
     phone = PhoneNumberField(blank=True)
     address = models.CharField(max_length=255, blank=True, null=True, default="",
@@ -430,6 +430,8 @@ def get_service_duration(self):
         return self.appointment_request.service.get_duration()
 
     def get_staff_member_name(self):
+        if not self.appointment_request.staff_member:
+            return ""
         return self.appointment_request.staff_member.get_staff_member_name()
 
     def get_staff_member(self):

appointment/templates/administration/manage_service.html

@@ -15,10 +15,10 @@ <h2>{{ page_title }}</h2>
                 <form method="post" enctype="multipart/form-data">
                     {% csrf_token %}
                     {{ form.as_p }}
-                    {% if btn_txt %}
+                    {% if btn_text %}
                         <button type="submit" class="btn btn-primary">{{ btn_text }}</button>
                     {% else %}
-                        {% if request.user.is_superuser %}
+                        {% if request.user.is_superuser and service.id %}
                             <div class="service-btn-container">
                                 <a href="{% url 'appointment:update_service' service_id=service.id %}"
                                    class="modify-btn button-color-blue service-btn">

appointment/tests/models/test_model_appointment.py

@@ -208,3 +208,15 @@ def test_appt_to_dict(self):
         actual_response = self.appointment.to_dict()
         actual_response.pop('id_request', None)
         self.assertEqual(actual_response, response)
+
+    def test_get_staff_member_name_with_staff_member(self):
+        """Test if you get_staff_member_name method returns the correct name when a staff member is associated."""
+        expected_name = self.staff_member1.get_staff_member_name()
+        actual_name = self.appointment.get_staff_member_name()
+        self.assertEqual(actual_name, expected_name)
+
+    def test_get_staff_member_name_without_staff_member(self):
+        """Test if you get_staff_member_name method returns an empty string when no staff member is associated."""
+        self.appointment.appointment_request.staff_member = None
+        self.appointment.appointment_request.save()
+        self.assertEqual(self.appointment.get_staff_member_name(), "")

docs/explanation.md

@@ -0,0 +1,86 @@
+# Django Appointment System: Screenshots and Tutorial
+
+Welcome to the Django Appointment System! This guide will walk you through setting up and using the system, complete with screenshots and a video tutorial.
+
+## Getting Started
+
+After completing the initial setup steps - making migrations, migrating, running the server, and creating a superuser - you might want to create an appointment as a client. However, this is not possible initially as no services or staff members are yet configured.
+
+### Adding a Service
+
+Your first step is to add a service. Navigate to the admin page and add a service at:
+https://mysuperwebsite.com/app-admin/add-service/
+
+![Creating Service](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/creating_service.png?raw=true)
+
+### Attempting to Create an Appointment
+
+If you attempt to create an appointment request now, it's still not possible as there are no staff members yet:
+
+![Appointment Request without Staff Member](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/appointment_request_w_sm.png?raw=true)
+
+Similarly, if you check the list of appointments, it will be empty and you'll get a warning:
+
+![Appointment List without Staff Member](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/appointment_list_admin.png?raw=true)
+
+### Adding a Staff Member
+
+To add a staff member, visit:
+
+![Staff Member List](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/staff_member_list.png?raw=true)
+
+You can either add a new staff member or assign yourself as a staff member, especially if you are a superuser. In this example, I will demonstrate using the `Staff me` button.
+
+### Updating Your Profile
+
+Once you have created a staff member profile, you need to specify the services you offer. After doing so, your initial profile page will look something like this:
+
+![Initial Profile](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/initial_profile.png?raw=true)
+
+To edit your appointment information, such as the services you offer, click on the edit icon next to `Appointment Information`:
+
+![Profile Edit](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/adding_service_to_profile.png?raw=true)
+
+After selecting the services you offer, you may leave other fields blank if desired, and then click `Save`.
+
+Additionally, select the days you wish to work by clicking the `add icon` next to `Working Hours`. For demonstration purposes, I have chosen Saturdays and Sundays from 9 AM to 5 PM.
+
+Your updated profile should look like this:
+
+![Profile after Editing](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/profile_after_editing.png?raw=true)
+
+### Client's Perspective: Creating Appointments
+
+Now, users can start creating appointments. The interface for clients would appear as follows:
+
+![Appointment Request with Staff Member](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/before_creating_appt_request.png?raw=true)
+
+Notice that only Saturdays and Sundays are selectable, with the only staff member (you) selected by default.
+
+Let's create an appointment request for Saturday, January 13th, 2024, at 3:00 PM:
+
+![Creating Appointment Request](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/creating_appt_request.png?raw=true)
+
+Next, add your personal information:
+
+![Adding Personal Information](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/adding_client_information.png?raw=true)
+
+### Payment Options
+
+If the service is paid and a payment link is set in settings, the `Pay now` button will appear. If down payments are accepted, a `Down Payment` button will also be available. Otherwise, a `Finish` button will be displayed.
+
+Upon completion, an account is created for the user, and an email is sent with appointment and account details, provided the email settings are correctly configured.
+
+### Managing Appointments
+
+As an admin, you can now view the newly created appointment in your staff member appointment list:
+
+![Admin Appointments](https://github.com/adamspd/django-appointment/blob/main/docs/screenshots/admin_appointments.png?raw=true)
+
+In the admin interface, you have various options to manage appointments, such as editing, adding new appointments, deleting, or rescheduling them by dragging and dropping.
+
+### Video Tutorial
+
+For a more comprehensive guide, including visual demonstrations of these steps, please watch the following video tutorial:
+
+[Link to Video Tutorial]