Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/app-generator/django-admin-coreui

Django Theme CoreUI - Free template for Django Admin UI | AppSeed
https://github.com/app-generator/django-admin-coreui

coreui-template coreui-theme django-coreui django-theme

Last synced: 14 days ago
JSON representation

Django Theme CoreUI - Free template for Django Admin UI | AppSeed

Host: GitHub
URL: https://github.com/app-generator/django-admin-coreui
Owner: app-generator
License: mit
Created: 2024-04-22T04:36:43.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-04-28T10:25:38.000Z (7 months ago)
Last Synced: 2024-10-29T10:21:40.075Z (18 days ago)
Topics: coreui-template, coreui-theme, django-coreui, django-theme
Language: HTML
Homepage:
Size: 20.7 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# [Django CoreUI Theme](https://appseed.us/product/coreui/django/)

Modern template for **Django Admin Interface** coded on top of **[CoreUI](https://appseed.us/product/coreui/django/)**, an iconic Bootstrap Dashboard template.

> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.

**Links & Resources**

- [Django CoreUI](https://appseed.us/product/coreui/django/) - `Product` that uses the library
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: `CoreUI`
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
- `Registration` page
- `Misc pages`: colors, icons, typography, blank-page

![CoreUI - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171336361-b125ca1d-8936-4f4a-b662-9e45ee25f404.png)

## Why `Django CoreUI Theme`

- Modern [Bootstrap](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
- `Responsive Interface`
- `Minimal Template` overriding
- `Easy integration`

For newcomers, **CoreUI** is a fully responsive administration template. Based on Bootstrap framework and also the JS/jQuery plugin. Highly customizable and easy to use.
Fits many screen resolutions from small mobile devices to large desktops.

## How to use it

> **Install the package** via `PIP`

```bash
$ pip install django-admin-coreui
// OR
$ pip install git+https://github.com/app-generator/django-admin-coreui.git
```

> Add `admin_coreui` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):

```python
INSTALLED_APPS = (
...
'admin_coreui.apps.AdminCoreuiConfig',
'django.contrib.admin',
)
```

> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:

```python
LOGIN_REDIRECT_URL = '/'
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
```

> Add `admin_coreui` urls in your Django Project `urls.py` file

```python
from django.urls import path, include

urlpatterns = [
...
path('', include('admin_coreui.urls')),
]
```

> **Collect static** if you are in `production environment`:

```bash
$ python manage.py collectstatic
```

> **Start the app**

```bash
$ # Set up the database
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Create the superuser
$ python manage.py createsuperuser
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
```

Access the `admin` section in the browser: `http://127.0.0.1:8000/`

## How to Customize

When a template file is loaded, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found.
The theme used to style this starter provides the following files:

When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path.

For instance, if we want to customize the `footer.html` these are the steps:

- `Step 1`: create the `templates` DIRECTORY inside your app
- `Step 2`: configure the project to use this new template directory
- Edit `settings.py` TEMPLATES section
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
- Source PATH: `/LIB/admin_coreui/templates/includes/footer.html`
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
- Edit the `footer.html` (Destination PATH)

At this point, the default version of the `footer.html` shipped in the library is ignored by Django.

In a similar way, all other files and components can be customized easily.

## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)

This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.

> Features:

- `Up-to-date Dependencies`
- `Design`: `Django Theme Material` (PRO Version)
- `Sections` covered by the design:
- **Admin section** (reserved for superusers)
- **Authentication**: `Django.contrib.AUTH`, Registration
- **All Pages** available in for ordinary users
- `Docker`, `Deployment`:
- `CI/CD` flow via `Render`

![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)

---
**[Django CoreUI Theme](https://appseed.us/product/coreui/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**