Skip to main content

Open-source Surface template with improved functionality

Project description

django-surface-theme

Surface theme is built on top of Django Dashboard Atlantis Dark.

Surface Theme variables

Define custom title in urls.py:

admin.site.site_title = "Surface Security"

Define side menu navigation items by adding the following variable in settings.py:

SURFACE_MENU_ITEMS = [
    {'label': ('Organisation'), 'icon': 'fas fa-building', 'items':[
        {'name': 'auth.user'}
    ]},
    {'label': ('Organisation'), 'app_label': 'auth', 'icon': 'fas fa-building', 'items':[
        {'name': 'user', 'label': 'Custom Label'},
        {'url': 'https://example.com', 'url_blank': True, 'label': 'Custom URL'}
    ]},
]

Define home links and items by adding the following variable in settings.py:

SURFACE_LINKS_ITEMS = [
    {'label': ('Examples'), 'items':[
        {'url': 'https://example.com', 'url_blank': True, 'name': 'Example.com'}
    ]}
]

ToDo

testapp is a demo app of the theme to cover all customizations and test them. TODO visual testing?

Package currently needs serious review:

  • TESTS!
  • every admin template should be reviewed against its core theme peer
  • bower takes care of atlantis SCSS but what is minifying/managing javascript files? min versions are out of sync...
  • login, logout, ... should replace admin templates, instead of requiring adding paths to urls.py - subclass AuthenticationForm instead of custom form as well
  • ...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-surface-theme-0.0.6.tar.gz (31.5 MB view hashes)

Uploaded Source

Built Distribution

django_surface_theme-0.0.6-py3-none-any.whl (36.7 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page