Installation with pip

Create a virtualenv environment, activate it and install the package with all the dependencies via:

pip install django-website-showroom

Manual Installation

  • Clone source repository from GitHub
  • Create a virtual environment with virtualenv
  • Install the requirements with pip install -r requirements.txt
  • Manually link the website_showroom folder to the site-packages folder of your environment


Create a separate Django project:

django-admin(.py) startproject my_showroom_project

Add haystack and the website_showroom app to INSTALLED_APPS in


The following settings are necessary for Haystack (search) to work:

# Haystack settings
    'default': {
        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
        'PATH': os.path.join(BASE_DIR, 'search_index'),
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

Add the import for the Showroom urls to your file and add a + to the Django admin urls assignment to the urlpatterns list:

from website_showroom.urls import urlpatterns

# Before: urlpatterns = [...]
# After: urlpatterns += [...]

Run Django migration command to create the DB tables and create an admin user:

python migrate
python createsuperuser

Now run the Django server command:

python manage runserver

You should be able to enter the Django admin with your user credentials at

Example Project

There is an example project where you can see a showroom in action!

  • Go to the example_project folder of the showroom lib installation
  • Create the DB with python migrate and load the initial example data with python loaddata example_project.json
  • Rebuild the search index with python rebuild_index
  • Run a Django server with python manage runserver
  • Admin credentials are “admin/admin”