|
| 1 | +# Django Appointment 📦 |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +[](https://badge.fury.io/py/django-appointment) |
| 6 | +[](https://codecov.io/gh/adamspd/django-appointment) |
| 7 | +[](https://opensource.org/licenses/Apache-2.0) |
| 8 | +[](https://github.com/adamspd/django-appointment/commits/main) |
| 9 | +[](https://github.com/adamspd/django-appointment/commit/main) |
| 10 | +[](https://github.com/adamspd/django-appointment/issues) |
| 11 | +[](https://github.com/adamspd/django-appointment/pulls) |
| 12 | +[](https://github.com/adamspd/django-appointment/graphs/contributors) |
| 13 | + |
| 14 | +⚠️ **IMPORTANT**: If upgrading from a version before 2.x.x, please note significant database changes were introduced in |
| 15 | +Version 2.0.0 introduces significant database changes. Please read |
| 16 | +the [migration guide](https://github.com/adamspd/django-appointment/tree/main/docs/migration_guides/v2_1_0.md) before |
| 17 | +updating. No database changes were introduced in version 3.0.1. |
| 18 | + |
| 19 | +Django-Appointment is a Django app engineered for managing appointment scheduling with ease and flexibility. It enables |
| 20 | +users to define custom configurations for time slots, lead time, and finish time, or utilize the default values |
| 21 | +provided. This app proficiently manages conflicts and availability for appointments, ensuring a seamless user |
| 22 | +experience. |
| 23 | + |
| 24 | +For a detailed walkthrough and live example of the system, please refer to |
| 25 | +[this tutorial](https://github.com/adamspd/django-appointment/tree/main/docs/explanation.md). |
| 26 | + |
| 27 | +Detailed documentation can be found in |
| 28 | +the [docs' directory](https://github.com/adamspd/django-appointment/tree/main/docs/README.md). |
| 29 | +For changes and migration information, please refer to the [release |
| 30 | +notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md). |
| 31 | + |
| 32 | +## Features ✨ |
| 33 | + |
| 34 | +1. Customizable time slots, lead time, and finish time. |
| 35 | +2. Competent handling of appointment conflicts and availability. |
| 36 | +3. Seamless integration with the Django admin interface for appointment management. |
| 37 | +4. Custom admin interface for managing appointment/staff member editing, creation, availability, and conflicts. |
| 38 | +5. User-friendly interface for viewing available time slots and scheduling appointments. |
| 39 | +6. Capability to send email notifications to clients upon scheduling an appointment. |
| 40 | + |
| 41 | +## Key features introduced in previous versions. |
| 42 | + |
| 43 | +- For more information, please refer to |
| 44 | + this [documentation](https://github.com/adamspd/django-appointment/tree/main/docs/history/readme_v2_1_1.md). |
| 45 | + |
| 46 | +## Added Features in version 3.0.1 |
| 47 | + |
| 48 | +This release of Django Appointment brings a series of improvements and updates aimed at enhancing the overall |
| 49 | +functionality and user experience: |
| 50 | + |
| 51 | +1. **Dynamic Appointment Management (#49, #55)** |
| 52 | + |
| 53 | +2. **User Interface Enhancements and JavaScript Refactoring (#55)** |
| 54 | + |
| 55 | +3. **Dynamic Label Customization in Appointment Pages (#19)** |
| 56 | + |
| 57 | +4. **Updated Documentation and Workflow Enhancements (#25, #26, #27)** |
| 58 | + |
| 59 | +5. **Community Engagement and Standards (#21, #22, #23, #24)** |
| 60 | + |
| 61 | +6. **Library Updates and Security Patches (#14, #15, #18)** |
| 62 | + |
| 63 | +7. **Enhanced Project Visibility (#16)** |
| 64 | + |
| 65 | +8. **Translation Refinements (#31)** |
| 66 | + |
| 67 | +9. **Bug Fixes (#48)** |
| 68 | + |
| 69 | +See more at the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md). |
| 70 | + |
| 71 | +These updates collectively contribute to the robustness and versatility of the Django Appointment package, aligning with |
| 72 | +our commitment to providing a high-quality and user-friendly appointment management solution. |
| 73 | + |
| 74 | +### Bug Fixes 🆕 |
| 75 | + |
| 76 | +See the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md) |
| 77 | +for more information. |
| 78 | + |
| 79 | +### Breaking Changes in version 3.0.1: |
| 80 | + |
| 81 | +See the [release notes](https://github.com/adamspd/django-appointment/tree/main/docs/release_notes/latest.md) for more |
| 82 | + information. |
| 83 | + |
| 84 | +## Quick Start 🚀 |
| 85 | + |
| 86 | +1. Add "appointment" to your `INSTALLED_APPS` setting like so: |
| 87 | + |
| 88 | + ```python |
| 89 | + INSTALLED_APPS = [ |
| 90 | + # other apps |
| 91 | + 'appointment', |
| 92 | + ] |
| 93 | + ``` |
| 94 | + |
| 95 | +2. Incorporate the appointment URLconf in your project's `urls.py` like so: |
| 96 | + |
| 97 | + ```python |
| 98 | + from django.urls import path, include |
| 99 | + |
| 100 | + urlpatterns = [ |
| 101 | + # other urls |
| 102 | + path('appointment/', include('appointment.urls')), |
| 103 | + ] |
| 104 | + ``` |
| 105 | + |
| 106 | +3. In your Django's `settings.py`, append the following: |
| 107 | + |
| 108 | + ```python |
| 109 | + AUTH_USER_MODEL = 'models.UserModel' # Optional if you use Django's user model |
| 110 | + ``` |
| 111 | + |
| 112 | + For instance, if you employ a custom user model: |
| 113 | + |
| 114 | + ```python |
| 115 | + AUTH_USER_MODEL = 'client.UserClient' |
| 116 | + ``` |
| 117 | + |
| 118 | + If you're utilizing the default Django user model, there's no need to add this line since Django automatically sets |
| 119 | + it to: |
| 120 | + |
| 121 | + ```python |
| 122 | + AUTH_USER_MODEL = 'auth.User' |
| 123 | + ``` |
| 124 | + |
| 125 | + Ensure your `create_user` function includes the following arguments, even if they are not all utilized: |
| 126 | + |
| 127 | + ```python |
| 128 | + def create_user(first_name, email, username, last_name=None, **extra_fields): |
| 129 | + pass |
| 130 | + ``` |
| 131 | + |
| 132 | + This function will create a user with a password formatted as: f"{APPOINTMENT_WEBSITE_NAME}{current_year}" |
| 133 | + |
| 134 | + For instance, if you append this to your `settings.py`: |
| 135 | + |
| 136 | + ```python |
| 137 | + APPOINTMENT_WEBSITE_NAME = 'Chocolates' |
| 138 | + ``` |
| 139 | + |
| 140 | + And the current year is 2023, the password will be "Chocolates2023". If `APPOINTMENT_WEBSITE_NAME` is not provided, |
| 141 | + the default value is "Website", rendering the password as "Website2023". |
| 142 | + |
| 143 | + This name is also utilized in the footer of the emails sent to clients upon scheduling an appointment: |
| 144 | + |
| 145 | + ```html |
| 146 | + <p>® 2023 {{ APPOINTMENT_WEBSITE_NAME }}. All Rights Reserved.</p> |
| 147 | + ``` |
| 148 | + |
| 149 | +4. Execute `python manage.py migrate` to create the appointment models. |
| 150 | +5. Launch the development server and navigate to http://127.0.0.1:8000/admin/ to create appointments, manage |
| 151 | + configurations, and handle appointment conflicts (the Admin app must be enabled). |
| 152 | +6. You must create at least one service before using the application on the admin page. If your service is free, input 0 |
| 153 | + as the price. If your service is paid, input the price in the price field. You may also provide a description for |
| 154 | + your service. |
| 155 | +7. Visit http://127.0.0.1:8000/appointment/request/<service_id>/ to view the available time slots and schedule an |
| 156 | + appointment. |
0 commit comments