├── core
    ├── __init__.py
    ├── wsgi.py
    ├── urls.py
    └── settings.py
├── notebook
    ├── migrations
    │   ├── __init__.py
    │   ├── 0002_auto_20170821_1235.py
    │   └── 0001_initial.py
    ├── __init__.py
    ├── static
    │   ├── img
    │   │   └── logo-algolia.png
    │   └── css
    │   │   └── style.css
    ├── urls.py
    ├── admin.py
    ├── apps.py
    ├── index.py
    ├── views.py
    ├── tests.py
    ├── models.py
    └── templates
    │   └── notebook
    │       ├── _base.html
    │       ├── auto_complete.html
    │       └── instant_search.html
├── requirements.txt
├── auto-complete.png
├── instant-search.png
├── manage.py
├── .gitignore
└── README.md


/core/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/notebook/migrations/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | algoliasearch-django>=1.3.2
2 | 


--------------------------------------------------------------------------------
/notebook/__init__.py:
--------------------------------------------------------------------------------
1 | default_app_config = 'notebook.apps.NotebookConfig'
2 | 


--------------------------------------------------------------------------------
/auto-complete.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/algolia/algoliasearch-django-example/HEAD/auto-complete.png


--------------------------------------------------------------------------------
/instant-search.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/algolia/algoliasearch-django-example/HEAD/instant-search.png


--------------------------------------------------------------------------------
/notebook/static/img/logo-algolia.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/algolia/algoliasearch-django-example/HEAD/notebook/static/img/logo-algolia.png


--------------------------------------------------------------------------------
/manage.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | import os
 3 | import sys
 4 | 
 5 | if __name__ == "__main__":
 6 |     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
 7 | 
 8 |     from django.core.management import execute_from_command_line
 9 | 
10 |     execute_from_command_line(sys.argv)
11 | 


--------------------------------------------------------------------------------
/notebook/urls.py:
--------------------------------------------------------------------------------
 1 | from django.conf.urls import url
 2 | from . import views
 3 | 
 4 | 
 5 | urlpatterns = [
 6 |     url(r'^$', views.index, name='index'),
 7 |     url(r'^auto-complete$', views.auto_complete, name='auto_complete'),
 8 |     url(r'^instant-search$', views.instant_search, name='instant_search')
 9 | ]
10 | 
11 | app_name = 'notebook'


--------------------------------------------------------------------------------
/notebook/admin.py:
--------------------------------------------------------------------------------
 1 | from django.contrib import admin
 2 | from .models import Contact
 3 | 
 4 | 
 5 | class ContactAdmin(admin.ModelAdmin):
 6 |     list_display = ('name', 'company', 'email', 'city', 'followers',
 7 |             'updated_at')
 8 |     list_filter = ['updated_at']
 9 |     search_fields = ['name', 'company', 'city']
10 | 
11 | 
12 | admin.site.register(Contact, ContactAdmin)
13 | 


--------------------------------------------------------------------------------
/notebook/apps.py:
--------------------------------------------------------------------------------
 1 | from django.apps import AppConfig
 2 | import algoliasearch_django as algoliasearch
 3 | from core import settings
 4 | 
 5 | from .index import ContactIndex
 6 | 
 7 | 
 8 | class NotebookConfig(AppConfig):
 9 |     name = 'notebook'
10 | 
11 |     def ready(self):
12 |         Contact = self.get_model('Contact')
13 |         if not settings.TESTING:
14 |             algoliasearch.register(Contact, ContactIndex)


--------------------------------------------------------------------------------
/core/wsgi.py:
--------------------------------------------------------------------------------
 1 | """
 2 | WSGI config for core project.
 3 | 
 4 | It exposes the WSGI callable as a module-level variable named ``application``.
 5 | 
 6 | For more information on this file, see
 7 | https://docs.djangoproject.com/en/1.8/howto/deployment/wsgi/
 8 | """
 9 | 
10 | import os
11 | 
12 | from django.core.wsgi import get_wsgi_application
13 | 
14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
15 | 
16 | application = get_wsgi_application()
17 | 


--------------------------------------------------------------------------------
/notebook/index.py:
--------------------------------------------------------------------------------
 1 | from algoliasearch_django import AlgoliaIndex
 2 | 
 3 | 
 4 | class ContactIndex(AlgoliaIndex):
 5 |     fields = ('name', 'email', 'company', 'address', 'city', 'county',
 6 |               'state', 'zip_code', 'phone', 'fax', 'web', 'followers', 'account_names', 'account_ids')
 7 | 
 8 |     settings = {
 9 |         'searchableAttributes': ['name', 'email', 'company', 'city', 'county', 'account_names',
10 |                                  'unordered(address)', 'state', 'zip_code', 'phone', 'fax',
11 |                                  'unordered(web)'],
12 |         'attributesForFaceting': ['city', 'company'],
13 |         'customRanking': ['desc(followers)'],
14 |         'queryType': 'prefixAll',
15 |         'highlightPreTag': '<mark>',
16 |         'highlightPostTag': '</mark>',
17 |         'hitsPerPage': 15
18 |     }
19 | 


--------------------------------------------------------------------------------
/notebook/views.py:
--------------------------------------------------------------------------------
 1 | from django.shortcuts import render, redirect
 2 | from django.conf import settings
 3 | from algoliasearch_django import get_adapter
 4 | from .models import Contact
 5 | 
 6 | def index(request):
 7 |     return redirect('notebook:instant_search', permanent=True)
 8 | 
 9 | def auto_complete(request):
10 |     context = {
11 |         'appID': settings.ALGOLIA['APPLICATION_ID'],
12 |         'searchKey': settings.ALGOLIA['SEARCH_API_KEY'],
13 |         'indexName': get_adapter(Contact).index_name
14 |     }
15 |     return render(request, 'notebook/auto_complete.html', context)
16 | 
17 | def instant_search(request):
18 |     context = {
19 |         'appID': settings.ALGOLIA['APPLICATION_ID'],
20 |         'searchKey': settings.ALGOLIA['SEARCH_API_KEY'],
21 |         'indexName': get_adapter(Contact).index_name
22 |     }
23 |     return render(request, 'notebook/instant_search.html', context)
24 | 


--------------------------------------------------------------------------------
/core/urls.py:
--------------------------------------------------------------------------------
 1 | """core URL Configuration
 2 | 
 3 | The `urlpatterns` list routes URLs to views. For more information please see:
 4 |     https://docs.djangoproject.com/en/1.8/topics/http/urls/
 5 | Examples:
 6 | Function views
 7 |     1. Add an import:  from my_app import views
 8 |     2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
 9 | Class-based views
10 |     1. Add an import:  from other_app.views import Home
11 |     2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
12 | Including another URLconf
13 |     1. Add an import:  from blog import urls as blog_urls
14 |     2. Add a URL to urlpatterns:  url(r'^blog/', include(blog_urls))
15 | """
16 | from django.conf.urls import include, url
17 | from django.contrib import admin
18 | 
19 | 
20 | urlpatterns = [
21 |     url(r'^', include('notebook.urls', namespace='notebook')),
22 |     url(r'^admin/', admin.site.urls),
23 | ]
24 | 


--------------------------------------------------------------------------------
/notebook/migrations/0002_auto_20170821_1235.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Generated by Django 1.11.2 on 2017-08-21 12:35
 3 | from __future__ import unicode_literals
 4 | 
 5 | from django.db import migrations, models
 6 | 
 7 | 
 8 | class Migration(migrations.Migration):
 9 | 
10 |     dependencies = [
11 |         ('notebook', '0001_initial'),
12 |     ]
13 | 
14 |     operations = [
15 |         migrations.CreateModel(
16 |             name='Account',
17 |             fields=[
18 |                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
19 |                 ('username', models.CharField(max_length=40)),
20 |                 ('service', models.CharField(max_length=40)),
21 |             ],
22 |         ),
23 |         migrations.AddField(
24 |             model_name='contact',
25 |             name='accounts',
26 |             field=models.ManyToManyField(to='notebook.Account'),
27 |         ),
28 |     ]
29 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Byte-compiled / optimized / DLL files
 2 | __pycache__/
 3 | *.py[cod]
 4 | 
 5 | # C extensions
 6 | *.so
 7 | 
 8 | # Distribution / packaging
 9 | .Python
10 | env/
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | *.egg-info/
23 | .installed.cfg
24 | *.egg
25 | 
26 | # PyInstaller
27 | #  Usually these files are written by a python script from a template
28 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
29 | *.manifest
30 | *.spec
31 | 
32 | # Installer logs
33 | pip-log.txt
34 | pip-delete-this-directory.txt
35 | 
36 | # Unit test / coverage reports
37 | htmlcov/
38 | .tox/
39 | .coverage
40 | .coverage.*
41 | .cache
42 | nosetests.xml
43 | coverage.xml
44 | *,cover
45 | 
46 | # Translations
47 | *.mo
48 | *.pot
49 | 
50 | # Django stuff:
51 | *.log
52 | 
53 | # Sphinx documentation
54 | docs/_build/
55 | 
56 | # PyBuilder
57 | target/
58 | 
59 | *.sqlite3
60 | 
61 | # IDE Files
62 | *.iml
63 | .idea/
64 | 


--------------------------------------------------------------------------------
/notebook/static/css/style.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |   padding-top: 70px;
 3 | }
 4 | 
 5 | #hits-stat a {
 6 |   display: inline-block;
 7 |   background: #23282D;
 8 |   padding: 1px 3px;
 9 | }
10 | 
11 | #hits-stat img {
12 |   height: 1em;
13 | }
14 | 
15 | .mark, mark {
16 |   padding: 0;
17 | }
18 | 
19 | .twitter-typeahead {
20 |   width: 100%;
21 | }
22 | 
23 | .twitter-typeahead .tt-input, .twitter-typeahead .tt-hint {
24 |   width: 100%;
25 |   margin: 0px;
26 |   padding: 8px 12px;
27 |   outline: none;
28 | }
29 | 
30 | .twitter-typeahead .tt-input:focus {
31 |   border: 2px solid #0097cf;
32 | }
33 | 
34 | .twitter-typeahead .tt-hint {
35 |   color: #999;
36 | }
37 | 
38 | .twitter-typeahead .tt-dropdown-menu {
39 |   width: 100%;
40 |   padding: 0;
41 |   background-color: #fff;
42 |   border: 1px solid rgba(0, 0, 0, 0.2);
43 |   border-top: 0px;
44 | }
45 | 
46 | .twitter-typeahead .tt-dropdown-menu .tt-suggestion {
47 |   text-align: left;
48 |   padding: 3px 20px;
49 |   font-size: 18px;
50 |   line-height: 24px;
51 | }
52 | 
53 | .twitter-typeahead .tt-dropdown-menu .tt-suggestion.tt-cursor {
54 |   color: #fff;
55 |   background-color: #0097cf;
56 | }
57 | 


--------------------------------------------------------------------------------
/notebook/tests.py:
--------------------------------------------------------------------------------
 1 | from unittest import TestCase
 2 | from . import models
 3 | 
 4 | 
 5 | class ContactTestCase(TestCase):
 6 |     def setUp(self):
 7 |         contacts = models.Contact.objects.all()
 8 |         for c in contacts:
 9 |             c.delete()
10 |         self.contact = models.Contact.objects.create(name="foo", email="foo@algolia.com")
11 |         self.account1 = models.Account.objects.create(username="test@x.com", service="X")
12 |         self.account2 = models.Account.objects.create(username="test@y.com", service="Y")
13 |         self.contact.accounts.add(self.account1, self.account2)
14 | 
15 |     def test_Contacts_account_ids(self):
16 |         """Contacts expose the correct account ids """
17 |         foo = models.Contact.objects.get(name="foo")
18 |         ids = foo.account_ids()
19 |         self.assertEqual(len(ids), 2)
20 |         self.assertTrue(self.account1.id in ids)
21 |         self.assertTrue(self.account2.id in ids)
22 | 
23 |     def test_Contacts_account_names(self):
24 |         """Contacts expose the correct account names """
25 |         foo = models.Contact.objects.get(name="foo")
26 |         names = foo.account_names()
27 |         self.assertEqual(len(names), 2)
28 |         self.assertTrue('test@x.com@X' in names)
29 |         self.assertTrue('test@y.com@Y' in names)
30 | 


--------------------------------------------------------------------------------
/notebook/models.py:
--------------------------------------------------------------------------------
 1 | from django.db import models
 2 | 
 3 | 
 4 | class Account(models.Model):
 5 |     username = models.CharField(max_length=40)
 6 |     service = models.CharField(max_length=40)
 7 | 
 8 |     def __str__(self):
 9 |         return self.username + "@" + self.service
10 | 
11 | 
12 | class Contact(models.Model):
13 |     name = models.CharField(max_length=40)
14 |     email = models.EmailField(max_length=60)
15 |     company = models.CharField(max_length=40)
16 |     address = models.CharField(max_length=60)
17 |     city = models.CharField(max_length=20)
18 |     county = models.CharField(max_length=20)
19 |     state = models.CharField(max_length=20)
20 |     zip_code = models.CharField(max_length=8)
21 |     phone = models.CharField(max_length=20)
22 |     fax = models.CharField(max_length=20)
23 |     web = models.CharField(max_length=30)
24 |     followers = models.IntegerField(default=0)
25 |     note = models.TextField()
26 |     created_at = models.DateTimeField(auto_now=False, auto_now_add=True)
27 |     updated_at = models.DateTimeField(auto_now=True)
28 | 
29 |     accounts = models.ManyToManyField(Account)
30 | 
31 |     def __str__(self):
32 |         return self.name
33 | 
34 |     def account_names(self):
35 |         return [str(account) for account in self.accounts.all()]
36 | 
37 |     def account_ids(self):
38 |         return [account.id for account in self.accounts.all()]
39 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # AlgoliaSearch Django Example
 2 | 
 3 | This is a Django application indexing 500 `Contact` objects and providing auto-completion and instant-search samples. See [algoliasearch-django](https://github.com/algolia/algoliasearch-django) package.
 4 | 
 5 | A `Contact` is defined by:
 6 | 
 7 | * A name
 8 | * An email address
 9 | * A company name
10 | 
11 | An [Algolia](https://www.algolia.com) account is required to test it.
12 | 
13 | ## Dependencies
14 | 
15 | ```bash
16 | $ pip install algoliasearch-django
17 | ```
18 | 
19 | ## Installation
20 | 
21 | ```bash
22 | $ git clone https://github.com/algolia/algoliasearch-django-example
23 | $ cd algoliasearch-django-example
24 | $ python manage.py migrate
25 | $ python manage.py createsuperuser
26 | ```
27 | 
28 | ## Configure the credentials
29 | 
30 | You can add your credentials in `core/settings.py` or you can export them in your environment:
31 | 
32 | ```bash
33 | $ export ALGOLIA_APPLICATION_ID=XXXXX
34 | $ export ALGOLIA_API_KEY=XXXXX
35 | $ export ALGOLIA_SEARCH_API_KEY=XXXXX
36 | ```
37 | 
38 | ## Populate the DB and start indexing
39 | 
40 | ```bash
41 | $ python manage.py loaddata contacts.json
42 | $ python manage.py algolia_reindex
43 | ```
44 | 
45 | ## Start the application
46 | 
47 | ```bash
48 | $ python manage.py runserver
49 | ```
50 | 
51 | Enjoy your `http://localhost:8000` examples!
52 | 
53 | ![Instant-search](instant-search.png)
54 | 
55 | ![Auto-complete](auto-complete.png)
56 | 


--------------------------------------------------------------------------------
/notebook/migrations/0001_initial.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | from __future__ import unicode_literals
 3 | 
 4 | from django.db import models, migrations
 5 | 
 6 | 
 7 | class Migration(migrations.Migration):
 8 | 
 9 |     dependencies = [
10 |     ]
11 | 
12 |     operations = [
13 |         migrations.CreateModel(
14 |             name='Contact',
15 |             fields=[
16 |                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
17 |                 ('name', models.CharField(max_length=40)),
18 |                 ('email', models.EmailField(max_length=60)),
19 |                 ('company', models.CharField(max_length=40)),
20 |                 ('address', models.CharField(max_length=60)),
21 |                 ('city', models.CharField(max_length=20)),
22 |                 ('county', models.CharField(max_length=20)),
23 |                 ('state', models.CharField(max_length=20)),
24 |                 ('zip_code', models.CharField(max_length=8)),
25 |                 ('phone', models.CharField(max_length=20)),
26 |                 ('fax', models.CharField(max_length=20)),
27 |                 ('web', models.CharField(max_length=30)),
28 |                 ('followers', models.IntegerField(default=0)),
29 |                 ('note', models.TextField()),
30 |                 ('created_at', models.DateTimeField(auto_now_add=True)),
31 |                 ('updated_at', models.DateTimeField(auto_now=True)),
32 |             ],
33 |         ),
34 |     ]
35 | 


--------------------------------------------------------------------------------
/notebook/templates/notebook/_base.html:
--------------------------------------------------------------------------------
 1 | {% load static %}
 2 | 
 3 | <!DOCTYPE html>
 4 | <html lang="en">
 5 |   <head>
 6 |     <meta charset="utf-8">
 7 |     <meta http-equiv="X-UA-Compatible" content="IE=edge">
 8 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 9 |     <title>AlgoliaSearch Example | {% block title %}{% endblock %}</title>
10 | 
11 |     <link href="//cdn.jsdelivr.net/bootstrap/3.3.5/css/bootstrap.min.css" rel="stylesheet">
12 |     <link href="{% static "css/style.css" %}" rel="stylesheet">
13 | 
14 |     {% block css %}
15 |     {% endblock %}
16 | 
17 |     <!--[if lt IE 9]>
18 |       <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
19 |       <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
20 |     <![endif]-->
21 |   </head>
22 |   <body>
23 |     <header>
24 |       <nav class="navbar navbar-default navbar-fixed-top">
25 |         <div class="container">
26 |           <div class="navbar-header">
27 |             <a class="navbar-brand" href="http://www.algolia.com">Algolia</a>
28 |           </div>
29 | 
30 |           <div class="collapse navbar-collapse">
31 |             <ul class="nav navbar-nav">
32 |               <li><a href="{% url "notebook:instant_search" %}">Instant-search</a></li>
33 |               <li><a href="{% url "notebook:auto_complete" %}">Auto-complete</a></li>
34 |             </ul>
35 |           </div>
36 |         </div>
37 |       </nav>
38 |     </header>
39 | 
40 |     <div class="container">
41 |       {% block content %}
42 |       <h1>Hello, world!</h1>
43 |       {% endblock %}
44 |     </div>
45 | 
46 |     <script src="//cdn.jsdelivr.net/jquery/2.1.4/jquery.js"></script>
47 |     <script src="//cdn.jsdelivr.net/bootstrap/3.3.5/js/bootstrap.min.js"></script>
48 |     <script src="//cdn.jsdelivr.net/g/algoliasearch,algoliasearch.helper"></script>
49 | 
50 |     {% block javascript %}
51 |     {% endblock %}
52 |   </body>
53 | </html>
54 | 


--------------------------------------------------------------------------------
/notebook/templates/notebook/auto_complete.html:
--------------------------------------------------------------------------------
 1 | {% extends "notebook/_base.html" %}
 2 | 
 3 | {% block title %}Auto-complete{% endblock %}
 4 | 
 5 | {% block content %}
 6 | <div class="row">
 7 |   <div class="col-sm-12">
 8 |     <p class="lead">A modern auto-complete field based on <code>typeahead.js</code> + <code>Hogan</code> and <code>AlgoliaSearch JS Client</code> example.</p>
 9 |   </div>
10 | </div>
11 | 
12 | <div class="row">
13 |   <div class="col-sm-6 col-sm-offset-3">
14 |     <p class="text-center search-terms">
15 |     Try
16 |     <a href="javascript:void(0)">John</a>,
17 |     <a href="javascript:void(0)">Jonn</a>,
18 |     <a href="javascript:void(0)">s row</a>,
19 |     <a href="javascript:void(0)">roeb</a>
20 |     </p>
21 |   </div>
22 | </div>
23 | 
24 | <div class="row">
25 |   <div class="col-sm-6 col-sm-offset-3">
26 |     <input id="q" placeholder="Search" autocomplete="off" autocorrect="false" spellcheck="false" type="search" />
27 |   </div>
28 | </div>
29 | 
30 | {% endblock %}
31 | 
32 | {% block javascript %}
33 | <script src="//cdn.jsdelivr.net/typeahead.js/0.10/typeahead.jquery.min.js"></script>
34 | <script src="//cdn.jsdelivr.net/hogan.js/3.0/hogan.min.js"></script>
35 | 
36 | {% verbatim %}
37 | <script type="text/template" id="autocomplete">
38 | <p>
39 |   {{{ _highlightResult.name.value }}}({{{ _highlightResult.email.value }}})
40 | </p>
41 | </script>
42 | {% endverbatim %}
43 | 
44 | <script>
45 | $(document).ready(function() {
46 |   var $inputField = $('#q');
47 | 
48 |   var template = Hogan.compile($('#autocomplete').text());
49 | 
50 |   var client = algoliasearch('{{ appID }}', '{{ searchKey }}');
51 |   var index = client.initIndex('{{ indexName }}');
52 | 
53 |   $('.search-terms a').click(function(e) {
54 |     $inputField.val($(this).text()).change().focus();
55 |   });
56 | 
57 |   $inputField.typeahead({hint: false}, {
58 |     source: index.ttAdapter(),
59 |     displayKey: 'email',
60 |     templates: {
61 |       suggestion: function(hit) {
62 |         return template.render(hit);
63 |       }
64 |     }
65 |   }).on('change', function(e) {
66 |     console.log('on(change): ' + $inputField.val());
67 |   }).on('keypress', function(e) {
68 |     console.log('on(submit): ' + $inputField.val());
69 |   }).on('typeahead:selected', function(e) {
70 |     console.log('on(selected): ' + $inputField.val());
71 |   });
72 | });
73 | </script>
74 | {% endblock %}
75 | 


--------------------------------------------------------------------------------
/core/settings.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Django settings for core project.
  3 | 
  4 | Generated by 'django-admin startproject' using Django 1.8.2.
  5 | 
  6 | For more information on this file, see
  7 | https://docs.djangoproject.com/en/1.8/topics/settings/
  8 | 
  9 | For the full list of settings and their values, see
 10 | https://docs.djangoproject.com/en/1.8/ref/settings/
 11 | """
 12 | 
 13 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 14 | import os
 15 | 
 16 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 17 | 
 18 | 
 19 | # Quick-start development settings - unsuitable for production
 20 | # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/
 21 | 
 22 | # SECURITY WARNING: keep the secret key used in production secret!
 23 | SECRET_KEY = 'r#gjo=@^vab5b_f&)4w4hubfb&1lb8l67!y5m073z3!t44-1&&'
 24 | 
 25 | # SECURITY WARNING: don't run with debug turned on in production!
 26 | DEBUG = True
 27 | 
 28 | # TESTING: Check if running tests
 29 | import sys
 30 | TESTING = sys.argv[1:2] == ['test']
 31 | ALLOWED_HOSTS = []
 32 | 
 33 | 
 34 | # Application definition
 35 | 
 36 | INSTALLED_APPS = (
 37 |     'django.contrib.admin',
 38 |     'django.contrib.auth',
 39 |     'django.contrib.contenttypes',
 40 |     'django.contrib.sessions',
 41 |     'django.contrib.messages',
 42 |     'django.contrib.staticfiles',
 43 |     'algoliasearch_django',
 44 |     'notebook'
 45 | )
 46 | 
 47 | MIDDLEWARE = (
 48 |     'django.middleware.security.SecurityMiddleware',
 49 |     'django.contrib.sessions.middleware.SessionMiddleware',
 50 |     'django.middleware.common.CommonMiddleware',
 51 |     'django.middleware.csrf.CsrfViewMiddleware',
 52 |     'django.contrib.auth.middleware.AuthenticationMiddleware',
 53 |     'django.contrib.messages.middleware.MessageMiddleware',
 54 |     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 55 | )
 56 | 
 57 | ROOT_URLCONF = 'core.urls'
 58 | 
 59 | TEMPLATES = [
 60 |     {
 61 |         'BACKEND': 'django.template.backends.django.DjangoTemplates',
 62 |         'DIRS': [],
 63 |         'APP_DIRS': True,
 64 |         'OPTIONS': {
 65 |             'context_processors': [
 66 |                 'django.template.context_processors.debug',
 67 |                 'django.template.context_processors.request',
 68 |                 'django.contrib.auth.context_processors.auth',
 69 |                 'django.contrib.messages.context_processors.messages',
 70 |             ],
 71 |         },
 72 |     },
 73 | ]
 74 | 
 75 | WSGI_APPLICATION = 'core.wsgi.application'
 76 | 
 77 | 
 78 | # Database
 79 | # https://docs.djangoproject.com/en/1.8/ref/settings/#databases
 80 | 
 81 | DATABASES = {
 82 |     'default': {
 83 |         'ENGINE': 'django.db.backends.sqlite3',
 84 |         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
 85 |     }
 86 | }
 87 | 
 88 | 
 89 | # Internationalization
 90 | # https://docs.djangoproject.com/en/1.8/topics/i18n/
 91 | 
 92 | LANGUAGE_CODE = 'en-us'
 93 | 
 94 | TIME_ZONE = 'UTC'
 95 | 
 96 | USE_I18N = True
 97 | 
 98 | USE_L10N = True
 99 | 
100 | USE_TZ = True
101 | 
102 | 
103 | # Static files (CSS, JavaScript, Images)
104 | # https://docs.djangoproject.com/en/1.8/howto/static-files/
105 | 
106 | STATIC_URL = '/static/'
107 | 
108 | # AlgoliaSearch settings
109 | ALGOLIA = {
110 |     'APPLICATION_ID': os.getenv('ALGOLIA_APPLICATION_ID'),
111 |     'API_KEY': os.getenv('ALGOLIA_API_KEY'),
112 |     'SEARCH_API_KEY': os.getenv('ALGOLIA_SEARCH_API_KEY'),
113 |     'INDEX_PREFIX': 'DjangoExample',
114 |     'INDEX_SUFFIX': 'dev'
115 | }
116 | 


--------------------------------------------------------------------------------
/notebook/templates/notebook/instant_search.html:
--------------------------------------------------------------------------------
  1 | {% extends "notebook/_base.html" %}
  2 | {% load static %}
  3 | 
  4 | {% block title %}Instant-search{% endblock %}
  5 | 
  6 | {% block content %}
  7 | <div class="row">
  8 |   <div class="col-sm-12">
  9 |     <p class="lead">A <code>Google-like</code> instant-search based on <code>AlgoliaSearch JS Client</code> + <code>Hogan</code> example.</p>
 10 |   </div>
 11 | </div>
 12 | 
 13 | <div class="row">
 14 |   <div class="col-sm-6 col-sm-offset-3">
 15 |     <input id="q" name="q" placeholder="Search" autocomplete="off" autocorrect="false" spellcheck="false" class="form-control" type="search" />
 16 |   </div>
 17 | </div>
 18 | 
 19 | <div class="row">
 20 |   <div class="col-sm-6 col-sm-offset-3">
 21 |     <p class="text-center search-terms">
 22 |     Try
 23 |     <a href="javascript:void(0)">John</a>,
 24 |     <a href="javascript:void(0)">Jonn</a>,
 25 |     <a href="javascript:void(0)">s row</a>,
 26 |     <a href="javascript:void(0)">roeb</a>
 27 |     </p>
 28 |   </div>
 29 | </div>
 30 | 
 31 | <div class="row">
 32 |   <div class="col-sm-12" id="hits-stat">
 33 |   </div>
 34 | </div>
 35 | 
 36 | <div class="row">
 37 |   <div class="col-sm-12">
 38 |     <div id="no-hits" class="col-sm-12 hidden"></div>
 39 | 
 40 |     <table id="hits-table" class="table table-striped hidden">
 41 |       <thead>
 42 |         <tr>
 43 |           <th style="width: 30%;">Name</th>
 44 |           <th style="witdh: 35%;">Company</th>
 45 |           <th style="width: 35%;">Email</th>
 46 |         </tr>
 47 |       </thead>
 48 |       <tbody id="hits">
 49 |       </tbody>
 50 |     </table>
 51 |   </div>
 52 | </div>
 53 | {% endblock %}
 54 | 
 55 | {% block javascript %}
 56 | <script src="//cdn.jsdelivr.net/hogan.js/3.0.2/hogan.min.js"></script>
 57 | 
 58 | {% verbatim %}
 59 | <script type="text/template" id="hit-template">
 60 | <tr>
 61 |   <td>{{{ _highlightResult.name.value }}}</td>
 62 |   <td>{{{ _highlightResult.company.value }}}</td>
 63 |   <td><a href="mailto:{{ email }}">{{{ _highlightResult.email.value }}}</a></td>
 64 | </tr>
 65 | </script>
 66 | {% endverbatim %}
 67 | 
 68 | <script>
 69 | $(document).ready(function() {
 70 |   var $inputField = $('#q');
 71 |   var $hits = $('#hits');
 72 |   var $hitsTable = $('#hits-table');
 73 |   var $noHits = $('#no-hits');
 74 |   var $hitsStat = $('#hits-stat');
 75 | 
 76 |   var hitTemplate = Hogan.compile($('#hit-template').text());
 77 | 
 78 |   var client = algoliasearch('{{ appID }}', '{{ searchKey }}');
 79 |   var helper = algoliasearchHelper(client, '{{ indexName }}');
 80 | 
 81 |   $('.search-terms a').click(function(e) {
 82 |     $inputField.val($(this).text()).change().focus();
 83 |     $inputField.keyup();
 84 |   });
 85 | 
 86 |   $inputField.on('keyup', function() {
 87 |     var query = $inputField.val();
 88 |     helper.setQuery(query).search();
 89 |   }).focus();
 90 | 
 91 |   helper.on('result', function(data) {
 92 |     renderHits(data);
 93 |   });
 94 | 
 95 |   helper.search(); // first search
 96 | 
 97 |   function renderHits(content) {
 98 |     var hitsHtml = '';
 99 | 
100 |     if (content.hits.length === 0) {
101 |       hitsHtml = '<p class="text-center text-danger lead">We didn\'t find any results for your search.</p>';
102 |       $noHits.html(hitsHtml);
103 |       $noHits.removeClass('hidden');
104 |       $hitsTable.addClass('hidden');
105 |     } else {
106 |       for (var i = 0; i < content.hits.length; ++i) {
107 |         hitsHtml += hitTemplate.render(content.hits[i]);
108 |       }
109 | 
110 |       $hits.html(hitsHtml);
111 |       $hitsTable.removeClass('hidden');
112 |       $noHits.addClass('hidden');
113 |     }
114 | 
115 |     $hitsStat.html('<p class="text-right">Found <b>' +
116 |         content.nbHits + '</b> results in <b>' + content.processingTimeMS + '</b>ms, ' +
117 |         'by <a href="http://www.algolia.com"><img src="{% static "img/logo-algolia.png" %}" /></a></p>'
118 |     );
119 |   }
120 | });
121 | </script>
122 | {% endblock %}
123 | 


--------------------------------------------------------------------------------