Installation

A guide on how to install Salesman.

1. Install using pip

pip install django-salesman

Note

Optionally install Pygments library for a nicer code display in admin.

2. Add to your settings.py

INSTALLED_APPS = [
    ...
    'salesman.core',
    'salesman.basket',
    'salesman.checkout',
    'salesman.orders',
    'salesman.admin',

    'rest_framework',
]

3. Add neccesary urls in urls.py

urlpatterns = [
    ...
    path('api/', include('salesman.urls')),
]

4. Run the migrations and start server

python manage.py migrate
python manage.py runserver

Done! Salesman is installed and you can navigate the API by going to http://localhost:8000/api/. But since no product types are configured there is nothing to be added to the basket yet.