Minor fixes & documentations (#60)

* Small fixes

* CSS fixes and some refactoring

* Updated CSS
Added service views

* Updated documentation & fixed a few incoherences

* appointment request screenshot (#58)

* updated models.md

* Updated models and readme

* Screenshots (#59)

* Added offered by screenshot

* Updated documentation & models

* Updated documentation & fixed failing tests

* Fixed get_locale failing test

* Fixed TestStaffMemberTimeFunctions appointment_buffer_time null error failing test

* Fixed appointment_buffer_time error

Author: adamspd

CONTRIBUTING.md

@@ -24,20 +24,23 @@ Pull requests are the best way to propose changes to the codebase. We actively w
 
 ## Any contributions you make will be under the Software License
 
-In short, when you submit code changes, your submissions are understood to be under the same [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0) that covers the project. Feel free to contact the maintainers if that's a concern.
+In short, when you submit code changes, your submissions are understood to be under the
+same [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0) that covers the project. Feel free to contact us
+if that's a concern.
 
 ## Report bugs using Github's [issues](https://github.com/adamspd/django-appointment/issues)
 
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/adamspd/django-appointment/issues/new); it's that easy!
+We use GitHub issues to track public bugs. Report a bug
+by [opening a new issue](https://github.com/adamspd/django-appointment/issues/new); it's that easy!
 
 ## Write bug reports with detail, background, and sample code
 
 **Great Bug Reports** tend to have:
 
 - A quick summary and/or background
 - Steps to reproduce
-  - Be specific!
-  - Give sample code if you can.
+    - Be specific!
+    - Give sample code if you can.
 - What you expected would happen
 - What actually happens
 - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
@@ -51,4 +54,5 @@ People *love* thorough bug reports.
 
 ## License
 
-By contributing, you agree that your contributions will be licensed under its [Apache 2.0 License](https://github.com/adamspd/django-appointment/LICENSE).
+By contributing, you agree that your contributions will be licensed under
+its [Apache 2.0 License](https://github.com/adamspd/django-appointment/LICENSE).

README.md

@@ -11,10 +11,10 @@
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/adamspd/django-appointment)](https://github.com/adamspd/django-appointment/pulls)
 [![GitHub contributors](https://img.shields.io/github/contributors/adamspd/django-appointment)](https://github.com/adamspd/django-appointment/graphs/contributors)
 
-⚠️ **IMPORTANT**: If upgrading from a version before 2.0.0, please note significant database changes were introduced in
+⚠️ **IMPORTANT**: If upgrading from a version before 2.x.x, please note significant database changes were introduced in
 Version 2.0.0 introduces significant database changes. Please read
 the [migration guide](https://github.com/adamspd/django-appointment/tree/main/docs/migration_guides/v2_1_0.md) before
-updating.
+updating. No significant database changes were introduced in version 3.0.0.
 
 Django-Appointment is a Django app engineered for managing appointment scheduling with ease and flexibility. It enables
 users to define custom configurations for time slots, lead time, and finish time, or utilize the default values
@@ -31,32 +31,37 @@ notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_note
 1. Customizable time slots, lead time, and finish time.
 2. Competent handling of appointment conflicts and availability.
 3. Seamless integration with the Django admin interface for appointment management.
-4. User-friendly interface for viewing available time slots and scheduling appointments.
-5. Capability to send email notifications to clients upon scheduling an appointment.
+4. Custom admin interface for managing appointment/staff member editing, creation, availability, and conflicts.
+5. User-friendly interface for viewing available time slots and scheduling appointments.
+6. Capability to send email notifications to clients upon scheduling an appointment.
 
 ## Key features introduced in previous versions.
 
 - For more information, please refer to
   this [documentation](https://github.com/adamspd/django-appointment/tree/main/docs/history/readme_v2_1_1.md).
 
-## Added Features in version 2.1.5
+## Added Features in version 3.0.0
 
 This release of Django Appointment brings a series of improvements and updates aimed at enhancing the overall
 functionality and user experience:
 
-1. **Dynamic Label Customization in Appointment Pages (#19)**
+1. **Dynamic Appointment Management (#49, #55)**
 
-2. **Updated Documentation and Workflow Enhancements (#25, #26, #27)**
+2. **User Interface Enhancements and JavaScript Refactoring (#55)**
 
-3. **Community Engagement and Standards (#21, #22, #23, #24)**
+3. **Dynamic Label Customization in Appointment Pages (#19)**
 
-4. **Library Updates and Security Patches (#14, #15, #18)**
+4. **Updated Documentation and Workflow Enhancements (#25, #26, #27)**
 
-5. **Enhanced Project Visibility (#16)**
+5. **Community Engagement and Standards (#21, #22, #23, #24)**
 
-6. **Translation Refinements (#31)**
+6. **Library Updates and Security Patches (#14, #15, #18)**
 
-7. **Bug Fixes (#48)**
+7. **Enhanced Project Visibility (#16)**
+
+8. **Translation Refinements (#31)**
+
+9. **Bug Fixes (#48)**
 
 See more at the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md).
 
@@ -68,10 +73,10 @@ our commitment to providing a high-quality and user-friendly appointment managem
 See the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md)
 for more information.
 
-### Breaking Changes in version 2.1.5:
-
-- None
+### Breaking Changes in version 3.0.0:
 
+See the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md) for more
+  information.
 
 ## Quick Start 🚀
 
@@ -178,7 +183,10 @@ information.
 
 ## Notes 📝⚠️
 
-Currently, the application does not send email reminders yet.
+Currently, the application does not send email reminders yet. I'm also working on a testing website for the application
+that is not fully functional yet, no hard feelings. But you can check it out
+at [https://django-appt.adamspierredavid.com/](https://django-appt.adamspierredavid.com/). Ideas are welcome here since
+I'm blocked on a few points.
 
 ## About the Author
 

SECURITY.md

@@ -3,30 +3,34 @@
 ## Supported Versions
 
 | Version | Supported          |
-| ------- | ------------------ |
+|---------|--------------------|
 | 2.x.x   | :white_check_mark: |
 | < 2.0   | :x:                |
 
 ## Reporting a Vulnerability
 
-The security of our project is a top priority. If you believe you have found a security vulnerability in Django-Appointment, we encourage you to let us know right away. We will investigate all legitimate reports and do our best to quickly fix the problem. Please follow these steps to report a vulnerability:
+The security of this project is a top priority. If you believe you have found a security vulnerability in
+Django-Appointment, we encourage you to let me know right away. We will investigate all legitimate reports and do our best
+to quickly fix the problem. Please follow these steps to report a vulnerability:
 
 1. **Do Not Publicly Disclose the Vulnerability**:
-   - Please do not publicly disclose the vulnerability until it has been handled by the security team.
+    - Please do not publicly disclose the vulnerability until it has been handled.
 
 2. **Contact Us Privately**:
-   - Send a detailed report to [this contact page](https://adamspierredavid.com/contact/).
-   - Include the affected versions and any other information that might be relevant.
+    - Send a detailed report to [this contact page](https://adamspierredavid.com/contact/)
+      or [create a new issue here](https://github.com/adamspd/django-appointment/issues/new/choose).
+    - Include the affected versions and any other information that might be relevant.
 
 3. **Wait for Initial Response**:
-   - We aim to respond to your report within 48 hours with our next steps.
+    - We aim to respond to your report within 48 hours with the next steps.
 
 4. **Coordinated Disclosure**:
-   - We will work with you to ensure we understand the scope of the issue and will arrange a coordinated disclosure plan.
+    - We will work with you to ensure we understand the scope of the issue and will arrange a coordinated disclosure
+      plan.
 
 ## Dependencies
 
-Our project depends on several third-party libraries:
+This project depends on several third-party libraries:
 
 - Django==4.2.7
 - Pillow==10.1.0
@@ -35,7 +39,8 @@ Our project depends on several third-party libraries:
 - babel==2.13.1
 - pytz~=2023.3.post1
 
-We strive to keep these dependencies up-to-date and free from vulnerabilities. If you find a vulnerability in one of these dependencies, please follow the steps above to report it.
+We strive to keep these dependencies up to date and free from vulnerabilities. If you find a vulnerability in one of
+these dependencies, please follow the steps above to report it.
 
 ## Policy Updates
 

appointment/__init__.py

@@ -4,5 +4,5 @@
 __description__ = "Managing appointment scheduling with customizable slots, staff features, and conflict handling."
 __package_name__ = "django-appointment"
 __url__ = "https://github.com/adamspd/django-appointment"
-__version__ = "2.1.5"
+__version__ = "3.0.0"
 __test_version__ = True

appointment/admin.py

@@ -9,9 +9,8 @@
 from django import forms
 from django.contrib import admin
 
-from .models import Service, AppointmentRequest, Appointment, EmailVerificationCode, Config, StaffMember, DayOff, \
-    WorkingHours
-from appointment.utils.db_helpers import get_user_model
+from .models import (
+    Appointment, AppointmentRequest, Config, DayOff, EmailVerificationCode, Service, StaffMember, WorkingHours)
 
 
 @admin.register(Service)

appointment/decorators.py

@@ -8,8 +8,6 @@
 
 from functools import wraps
 
-from django.http import JsonResponse
-
 from appointment.utils.error_codes import ErrorCode
 from appointment.utils.json_context import json_response
 from appointment.utils.view_helpers import is_ajax
@@ -19,6 +17,7 @@ def require_user_authenticated(func):
     """Decorator to require a user to be authenticated.
     Usage: @require_user_authenticated
     """
+
     @wraps(func)
     def wrapper(request, *args, **kwargs):
         if not request.user.is_authenticated:
@@ -32,6 +31,7 @@ def require_staff_or_superuser(func):
     """Decorator to require a user to be a staff or superuser.
     Usage: @require_staff_or_superuser
     """
+
     @wraps(func)
     def wrapper(request, *args, **kwargs):
         if not (request.user.is_staff or request.user.is_superuser):
@@ -45,6 +45,7 @@ def require_superuser(func):
     """Decorator to require a user to be a superuser.
     Usage: @require_superuser
     """
+
     @wraps(func)
     def wrapper(request, *args, **kwargs):
         if not request.user.is_superuser:
@@ -58,6 +59,7 @@ def require_ajax(func):
     """Decorator to require a request to be AJAX.
     Usage: @require_ajax
     """
+
     @wraps(func)
     def wrapper(request, *args, **kwargs):
         if not is_ajax(request):

appointment/forms.py

@@ -11,7 +11,7 @@
 from phonenumber_field.formfields import PhoneNumberField
 from phonenumber_field.widgets import PhoneNumberPrefixWidget
 
-from .models import AppointmentRequest, Appointment, WorkingHours, DayOff, StaffMember, Service
+from .models import Appointment, AppointmentRequest, DayOff, Service, StaffMember, WorkingHours
 from .utils.db_helpers import get_user_model
 
 

appointment/models.py

@@ -145,7 +145,7 @@ def get_down_payment(self):
         else:
             return self.down_payment  # Return the original float value
 
-    def get_down_payment_str(self):
+    def get_down_payment_text(self):
         if self.down_payment == 0:
             return f"Free"
         return f"{self.get_down_payment()}{self.get_currency_icon()}"
@@ -178,7 +178,7 @@ class StaffMember(models.Model):
         help_text=_("Time when the staff member stops working.")
     )
     appointment_buffer_time = models.FloatField(
-        null=True,
+        blank=True, null=True,
         help_text=_("Time between now and the first available slot for the current day (doesn't affect tomorrow). "
                     "e.g: If you start working at 9:00 AM and the current time is 8:30 AM and you set it to 30 "
                     "minutes, the first available slot will be at 9:00 AM. If you set the appointment buffer time to "
@@ -198,7 +198,7 @@ def get_slot_duration(self):
         config = Config.objects.first()
         return self.slot_duration or (config.slot_duration if config else 0)
 
-    def get_slot_duration_str(self):
+    def get_slot_duration_text(self):
         slot_duration = self.get_slot_duration()
         return convert_minutes_in_human_readable_format(slot_duration)
 
@@ -232,7 +232,7 @@ def get_non_working_days(self):
             non_working_days.append(0)  # Sunday
         return non_working_days
 
-    def get_weekend_days_worked_str(self):
+    def get_weekend_days_worked_text(self):
         if self.work_on_saturday and self.work_on_sunday:
             return _("Saturday and Sunday")
         elif self.work_on_saturday:
@@ -245,14 +245,14 @@ def get_weekend_days_worked_str(self):
     def get_services_offered(self):
         return self.services_offered.all()
 
-    def get_service_offered_str(self):
+    def get_service_offered_text(self):
         return ', '.join([service.name for service in self.services_offered.all()])
 
     def get_appointment_buffer_time(self):
         config = Config.objects.first()
         return self.appointment_buffer_time or (config.appointment_buffer_time if config else 0)
 
-    def get_appointment_buffer_time_str(self):
+    def get_appointment_buffer_time_text(self):
         # convert buffer time (which is in minutes) in day hours minutes if necessary
         return convert_minutes_in_human_readable_format(self.get_appointment_buffer_time())
 
@@ -458,7 +458,7 @@ def is_paid(self):
             return True
         return self.paid
 
-    def is_paid_txt(self):
+    def is_paid_text(self):
         return _("Yes") if self.is_paid() else _("No")
 
     def get_appointment_amount_to_pay(self):
@@ -468,7 +468,7 @@ def get_appointment_amount_to_pay(self):
         else:
             return self.amount_to_pay  # Return the original float value
 
-    def get_appointment_amount_to_pay_str(self):
+    def get_appointment_amount_to_pay_text(self):
         if self.amount_to_pay == 0:
             return "Free"
         return f"{self.get_appointment_amount_to_pay()}{self.get_service().get_currency_icon()}"
@@ -625,6 +625,9 @@ class PaymentInfo(models.Model):
     def __str__(self):
         return f"{self.appointment.get_service_name()} - {self.appointment.get_service_price()}"
 
+    def __repr__(self):
+        return f"{self.appointment.get_service_name()} - {self.appointment.get_service_price()}"
+
     def get_id_request(self):
         return self.appointment.get_appointment_id_request()
 

appointment/services.py

@@ -515,6 +515,9 @@ def create_staff_member_service(post_data):
         }
         user = create_new_user(client_data=user_data)
         StaffMember.objects.create(user=user)
+        if not user.is_superuser:
+            user.is_staff = True
+            user.save()
         return user, True, None
     else:
         return None, False, get_error_message_in_form(form=form)

appointment/static/css/app_admin/admin.css

@@ -1,6 +1,6 @@
 /* Hide scrollbar for day grid month view on small screens */
 
-@media (max-width: 500px) {
+@media (max-width: 767px) {
     .djangoAppt_no-events {
         margin-bottom: 10px;
     }