File tree 1 file changed +34
-4
lines changed
1 file changed +34
-4
lines changed Original file line number Diff line number Diff line change 9
9
![ Django Versions] ( https://img.shields.io/badge/django-%3E%3D3.2-brightgreen )
10
10
[ ![ PyPI License] ( https://img.shields.io/pypi/l/django-typesense.svg )] ( https://pypi.org/project/django-typesense/ )
11
11
12
-
13
12
## What is it?
13
+
14
14
Faster Django Admin powered by [ Typesense] ( https://typesense.org/ )
15
15
16
16
## Quick Start Guide
17
+
17
18
### Installation
18
- ` pip install django-typesense `
19
+
20
+ ``` sh
21
+ pip install django-typesense
22
+ ```
19
23
20
24
or install directly from github to test the most recent version
21
25
22
- ` pip install git+https://github.com/Siege-Software/django-typesense.git `
26
+ ``` sh
27
+ pip install git+https://github.com/Siege-Software/django-typesense.git
28
+ ```
29
+
30
+ ### Configuration
23
31
24
- Add ` django_typesense ` to the list of installed apps.
32
+ Update your ` settings.py ` to inlcude the following
33
+
34
+ - Add ` django_typesense ` to the list of installed apps.
35
+
36
+ ``` py
37
+ // settings.py
38
+ INSTALLED_APPS = [
39
+ ...
40
+ " django_typesense"
41
+ ]
42
+ ```
43
+
44
+ - Add typesense connection details
45
+
46
+ ``` py
47
+ // settings.py
48
+ ...
49
+ TYPESENSE = {
50
+ " api_key" : " xyz" ,
51
+ " nodes" : [{" host" : " 0.0.0.0" , " port" : " 8108" , " protocol" : " http" }],
52
+ " connection_timeout_seconds" : 2
53
+ }
54
+ ```
25
55
26
56
Follow this [ guide] ( https://typesense.org/docs/guide/install-typesense.html#option-1-typesense-cloud ) to install and run typesense
27
57
You can’t perform that action at this time.
0 commit comments