django-candy 0.7.2

A modern, single-page-app admin for Django.

A modern, single-page-app admin for Django.

Installation

/!\ Note: This is a pre-alpha project. Most of the things don't work. However, if you're curious, you can still try it out.

1. Install using pip

$ pip install django-candy

2. Modify your settings

# settings.py

INSTALLED_APPS = [
    # ...
    'django_candy',
]

3. Modify your project's urls.py

# urls.py

urlpatterns = [
    # ...
    path('candy/', include('django_candy.urls')),
]

Usage

After installation, you can visit http://127.0.0.1:8000/candy/ to see the admin interface in action.

1. Register your models

The API is pretty similar to that of Django's default admin:

# admin.py

from django_candy import admin
from myapp.models import MyModel

admin.site.register(MyModel)

Reload the admin page and you should see your registered model there.

Currently, the add/edit pages don't work. You can add some objects to your model from django shell and you'll see them listed on list page.

2. ModelAdmin class

There's also a ModelAdmin class for better control over the admin ui:

# admin.py

from django_candy import admin
from myapp.models import MyModel

class MyModelAdmin(admin.ModelAdmin):
    list_display = ['field_1', 'field_2', 'etc']

admin.site.register(MyModel, MyModelAdmin)

---

Full docs coming in due time.

Frontend

Frontend is written in React. You can find the source at https://github.com/bhch/candy-frontend.

License

BSD-3-Clause