Skip to content

Commit 212446e

Browse files
app-generatorapp-generator
committed
v1.0.3 - Update RM Links
1 parent e6945f0 commit 212446e

File tree

3 files changed

+20
-172
lines changed

3 files changed

+20
-172
lines changed

‎CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGELOG
22

3+
## [1.0.3] 2024-11-13
4+
### Changes
5+
6+
- Update RM Links:
7+
- [Django Admin CoreUI](https://app-generator.dev/docs/products/django-libs/theme-coreui.html) - Documentation & Support Links
8+
- [Django CoreUI](https://app-generator.dev/product/coreui/django/) - The product that uses the library
9+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
10+
311
## [1.0.2] 2024-04-28
412
### Changes
513

‎README.md

Lines changed: 11 additions & 171 deletions
Original file line numberDiff line numberDiff line change
@@ -1,187 +1,27 @@
1-
# [Django CoreUI Theme](https://appseed.us/product/coreui/django/)
1+
# [Django CoreUI](https://app-generator.dev/docs/products/django-libs/theme-coreui.html)
22

3-
Modern template for **Django Admin Interface** coded on top of **[CoreUI](https://appseed.us/product/coreui/django/)**, an iconic Bootstrap Dashboard template.
3+
Modern template for **[Django Admin](https://app-generator.dev/docs/products/django-libs/theme-coreui.html)**, Auth Pages (registration included) crafted on top of **CoreUI**, an open-source **Bootstrap** design.
44

5-
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
5+
- [Django Admin CoreUI](https://app-generator.dev/docs/products/django-libs/theme-coreui.html) - Documentation & Support Links
6+
- [Django CoreUI](https://app-generator.dev/product/coreui/django/) - The product that uses the library
7+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
68

7-
<br>
9+
<br />
810

9-
**Links & Resources**
11+
## **Features**
1012

11-
- [Django CoreUI](https://appseed.us/product/coreui/django/) - `Product` that uses the library
12-
- `Features`: Fully-configured, `CI/CD` via Render
13-
- UI Kit: `CoreUI`
13+
- Design: **[CoreUI](https://app-generator.dev/docs/templates/bootstrap/coreui.html)** (Bootstrap)
1414
- **Sections Covered**:
1515
- `Admin Section`, reserved for `superusers`
1616
- `All pages` managed by `Django.contrib.AUTH`
1717
- `Registration` page
1818
- `Misc pages`: colors, icons, typography, blank-page
19-
20-
<br />
21-
22-
![CoreUI - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171336361-b125ca1d-8936-4f4a-b662-9e45ee25f404.png)
23-
24-
<br />
25-
26-
## Why `Django CoreUI Theme`
27-
28-
- Modern [Bootstrap](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
29-
- `Responsive Interface`
30-
- `Minimal Template` overriding
31-
- `Easy integration`
32-
33-
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.
34-
Fits many screen resolutions from small mobile devices to large desktops.
35-
36-
<br />
37-
38-
## How to use it
39-
40-
<br />
41-
42-
> **Install the package** via `PIP`
43-
44-
```bash
45-
$ pip install django-admin-coreui
46-
// OR
47-
$ pip install git+https://github.com/app-generator/django-admin-coreui.git
48-
```
49-
50-
<br />
51-
52-
> Add `admin_coreui` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
53-
54-
```python
55-
INSTALLED_APPS = (
56-
...
57-
'admin_coreui.apps.AdminCoreuiConfig',
58-
'django.contrib.admin',
59-
)
60-
```
61-
62-
<br />
63-
64-
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
65-
66-
```python
67-
LOGIN_REDIRECT_URL = '/'
68-
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
69-
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
70-
```
71-
72-
<br />
73-
74-
> Add `admin_coreui` urls in your Django Project `urls.py` file
75-
76-
```python
77-
from django.urls import path, include
78-
79-
urlpatterns = [
80-
...
81-
path('', include('admin_coreui.urls')),
82-
]
83-
```
84-
85-
<br />
86-
87-
> **Collect static** if you are in `production environment`:
88-
89-
```bash
90-
$ python manage.py collectstatic
91-
```
92-
93-
<br />
94-
95-
> **Start the app**
96-
97-
```bash
98-
$ # Set up the database
99-
$ python manage.py makemigrations
100-
$ python manage.py migrate
101-
$
102-
$ # Create the superuser
103-
$ python manage.py createsuperuser
104-
$
105-
$ # Start the application (development mode)
106-
$ python manage.py runserver # default port 8000
107-
```
108-
109-
Access the `admin` section in the browser: `http://127.0.0.1:8000/`
110-
111-
<br />
112-
113-
## How to Customize
114-
115-
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.
116-
The theme used to style this starter provides the following files:
117-
118-
```bash
119-
# This exists in ENV: LIB/admin_coreui
120-
< UI_LIBRARY_ROOT >
121-
|
122-
|-- templates/ # Root Templates Folder
123-
| |
124-
| |-- accounts/
125-
| | |-- login.html # Sign IN Page
126-
| | |-- register.html # Sign UP Page
127-
| |
128-
| |-- includes/
129-
| | |-- footer.html # Footer component
130-
| | |-- sidebar.html # Sidebar component
131-
| | |-- navigation.html # Navigation Bar
132-
| | |-- scripts.html # Scripts Component
133-
| |
134-
| |-- layouts/
135-
| | |-- base.html # Masterpage
136-
| | |-- base-auth.html # Masterpage for Auth Pages
137-
| |
138-
| |-- pages/
139-
| |-- index.html # Dashboard Page
140-
| |-- calendar.html # Profile Page
141-
| |-- *.html # All other pages
142-
|
143-
|-- ************************************************************************
144-
```
145-
146-
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.
147-
148-
For instance, if we want to customize the `footer.html` these are the steps:
149-
150-
- `Step 1`: create the `templates` DIRECTORY inside your app
151-
- `Step 2`: configure the project to use this new template directory
152-
- Edit `settings.py` TEMPLATES section
153-
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
154-
- Source PATH: `<YOUR_ENV>/LIB/admin_coreui/templates/includes/footer.html`
155-
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
156-
- Edit the `footer.html` (Destination PATH)
157-
158-
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
159-
160-
In a similar way, all other files and components can be customized easily.
161-
162-
<br />
163-
164-
165-
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
166-
167-
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.
168-
169-
> Features:
170-
171-
- `Up-to-date Dependencies`
172-
- `Design`: `Django Theme Material` (PRO Version)
173-
- `Sections` covered by the design:
174-
- **Admin section** (reserved for superusers)
175-
- **Authentication**: `Django.contrib.AUTH`, Registration
176-
- **All Pages** available in for ordinary users
177-
- `Docker`, `Deployment`:
178-
- `CI/CD` flow via `Render`
179-
19+
18020
<br />
18121

182-
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
22+
![Django CoreUI - Modern template for Django Admin Section crafted on top of a modern Bootstrap, Open-Source Design.](https://user-images.githubusercontent.com/51070104/171336361-b125ca1d-8936-4f4a-b662-9e45ee25f404.png)
18323

18424
<br />
18525

18626
---
187-
**[Django CoreUI Theme](https://appseed.us/product/coreui/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
27+
**[Django CoreUI](https://app-generator.dev/docs/products/django-libs/theme-coreui.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setup(
1010
name='django-admin-coreui',
11-
version='1.0.2',
11+
version='1.0.3',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,

0 commit comments

Comments
 (0)