cr4zyd3v / djaodjin-saas

Django application for software-as-service and subscription businesses

djaodjin-saas is a Django application that implements the logic to support subscription-based Software-as-a-Service businesses.

Major Features:

• Separate billing profiles and authenticated users
• Double entry book keeping ledger
• Flexible security framework

Tested with

• Python: 2.7, Django: 1.11.23 (LTS), Django Rest Framework: 3.9.4
• Python: 3.6, Django: 1.11.23 (LTS), Django Rest Framework: 3.9.4
• Python: 3.6, Django: 2.2.4 (latest, LTS), Django Rest Framework: 3.9.4

This project contains bare bone templates which are compatible with Django and Jinja2 template engines. To see djaodjin-saas in action as part of a full-fledged subscription-based session proxy, take a look at djaoapp.

Full documentation for the project is available at Read-the-Docs

Development

After cloning the repository, create a virtualenv environment and install the prerequisites:

    $ virtualenv installTop
    $ source installTop/bin/activate
    $ pip install -r testsite/requirements.txt

To use the testsite, you will need to add the payment processor keys (see Processor Backends) and Django secret key into a credentials file. Example with Stripe:

    $ cat ./credentials

    SECRET_KEY = "enough_random_data"
    STRIPE_PUB_KEY = "your_stripe_public_api_key"
    STRIPE_PRIV_KEY = "your_stripe_private_api_key"

It remains to create the database and populate it with test data.

$ python ./manage.py migrate --run-syncdb --noinput
$ python ./manage.py loaddata testsite/fixtures/test_data.json

The test_data.json fixture contains the minimal amount of data to make the testsite usable. If you want to load a bigger set of dummy data, you could run the load_test_transactions command.

$ python ./manage.py load_test_transactions

If all is well then, you are ready to run the server and browse the testsite.

$ python manage.py runserver

# Browse http://localhost:8000/
# Login with username: alice and password: yoyo

Implementation Notes

The latest versions of django-restframework (>=3.0) implement paginators disconnected from parameters in views (i.e. no more paginate_by). You will thus need to define PAGE_SIZE in your settings.py

$ diff testsite/settings.py
+REST_FRAMEWORK = {
+    'PAGE_SIZE': 25,
+    'DEFAULT_PAGINATION_CLASS':
+        'rest_framework.pagination.PageNumberPagination',
+}

This Django App does not send notification e-mails itself. All major updates that would result in a e-mail sent trigger signals though. It is straightforward to send e-mails on a signal trigger in the main Django project. We provide sample e-mail templates here in the saas/templates/notification/ directory.

Release Notes

0.7.0

• adds marketplace processing fee
• restricts coupon to plan or number of use through UI
• fixes invite new organizations with erroneous slugs

previous release notes