Quick start

1. Add the following required Django settings:

   INSTALLED_APPS = [
       ...
    'django.contrib.sites',
       'gift_registry',
    ...
   ]
   
   SITE_ID = 1
   GIFT_REGISTRY_SETTINGS = {
       'EVENT_NAME': "Alice and Bob's Wedding",
   }

2. Include the gifts URLconf in your project urls.py like this:

   path('', include('gift_registry.urls')),

   and a line to serve uploaded media in development:

   from django.conf import settings
   from django.conf.urls.static import static
   urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

3. Run python manage.py migrate to create the Gift Registry models.

4. Run python manage.py createsuperuser --username=admin --email=test@example.com.

5. Start the development server and visit the Django Admin at http://127.0.0.1:8000/admin/gift_registry/gift/ to add gift ideas.

6. Visit http://127.0.0.1:8000/ to browse the public list.

7. Before deployment, be sure to add a “Site” via the Django Admin to ensure the outgoing emails include the correct link back to the website.

Customising

There’s a good chance that you’ll want to customise the look and feel. You do this by overriding the built-in templates.

Add your own template directory to settings.TEMPLATE_DIRS and override the base template here. To do this, first create a gift_registry directory in your templates directory. Then from within the django-gift-registry package, copy gift_registry/templates/gift_registry/base.html into your newly created gift_registry directory. Customise this base.html file with your own HTML and CSS.

Release History