Skip to content

Commit c5747fb

Browse files
authored
Merge pull request #128 from adamspd/fix/installation-documentation
Updated documentation about installation
2 parents a5c3a7d + 3fa97a5 commit c5747fb

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,13 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
5656

5757
## Quick Start 🚀
5858

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:
6066

6167
```python
6268
INSTALLED_APPS = [
@@ -66,7 +72,7 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
6672
]
6773
```
6874

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`:
7076

7177
```python
7278
from django.urls import path, include
@@ -76,7 +82,7 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
7682
path('appointment/', include('appointment.urls')),
7783
]
7884
```
79-
3. In your Django's `settings.py`, append the following:
85+
4. In your Django's `settings.py`, append the following:
8086

8187
```python
8288
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
136142
}
137143
```
138144

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.
140146

141-
5. Start the Django Q cluster with `python manage.py qcluster`.
147+
6. Start the Django Q cluster with `python manage.py qcluster`.
142148

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
144150
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
146152
as the price. If your service is paid, input the price in the price field. You may also provide a description for
147153
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
149155
appointment.
150156

151157
## Docker Support 🐳

appointment/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
__package_name__ = "django-appointment"
66
__url__ = "https://github.com/adamspd/django-appointment"
77
__package_website__ = "https://django-appt.adamspierredavid.com/"
8-
__version__ = "3.3.2"
8+
__version__ = "3.3.3"
99
__test_version__ = False

0 commit comments

Comments
 (0)