@@ -56,7 +56,13 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
56
56
57
57
## Quick Start 🚀
58
58
59
- 1 . Add "appointment" (& "django_q" if you want to enable email reminders) to your ` INSTALLED_APPS ` setting like so:
59
+ 1 . Install Django-Appointment in your project using pip:
60
+
61
+ ``` bash
62
+ pip install django-appointment
63
+ ```
64
+
65
+ 2 . Add "appointment" (& "django_q" if you want to enable email reminders) to your ` INSTALLED_APPS ` setting like so:
60
66
61
67
``` python
62
68
INSTALLED_APPS = [
@@ -66,7 +72,7 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
66
72
]
67
73
```
68
74
69
- 2 . Then, incorporate the appointment URLconf in your project's ` urls.py ` :
75
+ 3 . Then, incorporate the appointment URLconf in your project's ` urls.py ` :
70
76
71
77
``` python
72
78
from django.urls import path, include
@@ -76,7 +82,7 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
76
82
path(' appointment/' , include(' appointment.urls' )),
77
83
]
78
84
```
79
- 3 . In your Django's ` settings.py ` , append the following:
85
+ 4 . In your Django's ` settings.py ` , append the following:
80
86
81
87
``` python
82
88
AUTH_USER_MODEL = ' models.UserModel' # Optional if you use Django's user model
@@ -136,16 +142,16 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
136
142
}
137
143
```
138
144
139
- 4 . Next would be to run ` python manage.py migrate ` to create the appointment models.
145
+ 5 . Next would be to run ` python manage.py migrate ` to create the appointment models.
140
146
141
- 5 . Start the Django Q cluster with ` python manage.py qcluster ` .
147
+ 6 . Start the Django Q cluster with ` python manage.py qcluster ` .
142
148
143
- 6 . Launch the development server and navigate to http://127.0.0.1:8000/admin/ to create appointments, manage
149
+ 7 . Launch the development server and navigate to http://127.0.0.1:8000/admin/ to create appointments, manage
144
150
configurations, and handle appointment conflicts (the Admin app must be enabled).
145
- 7 . You must create at least one service before using the application on the admin page. If your service is free, input 0
151
+ 8 . You must create at least one service before using the application on the admin page. If your service is free, input 0
146
152
as the price. If your service is paid, input the price in the price field. You may also provide a description for
147
153
your service.
148
- 8 . Visit http://127.0.0.1:8000/appointment/request/ <service_id>/ to view the available time slots and schedule an
154
+ 9 . Visit http://127.0.0.1:8000/appointment/request/ <service_id>/ to view the available time slots and schedule an
149
155
appointment.
150
156
151
157
## Docker Support 🐳
0 commit comments