Skip to content

Commit e81a418

Browse files
app-generatorapp-generator
committed
Release v0.0.1
1 parent ba96ae8 commit e81a418

File tree

6 files changed

+223
-7
lines changed

6 files changed

+223
-7
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CHANGELOG
2+
3+
## [0.0.1] 2024-04-28
4+
### Changes
5+
6+
- Minimal version

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 [App Generator](https://appseed.us)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎MANIFEST.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include LICENSE
22
include README.rst
3-
recursive-include django_admin_coreui/static *
4-
recursive-include django_admin_coreui/templates *
3+
recursive-include admin_adminlte/static *
4+
recursive-include admin_adminlte/templates *
55
recursive-include docs *

‎README.md

+187-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,187 @@
1-
# django-admin-coreui
1+
# [Django CoreUI Theme](https://appseed.us/product/coreui/django/)
2+
3+
Modern template for **Django Admin Interface** coded on top of **[CoreUI](https://appseed.us/product/coreui/django/)**, an iconic Bootstrap Dashboard template.
4+
5+
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
6+
7+
<br>
8+
9+
**Links & Resources**
10+
11+
- [Django CoreUI](https://appseed.us/product/adminlte/django/) - `Product` that uses the library
12+
- `Features`: Fully-configured, `CI/CD` via Render
13+
- UI Kit: `AdminLTE` by ColorLib **v3.2.0**
14+
- **Sections Covered**:
15+
- `Admin Section`, reserved for `superusers`
16+
- `All pages` managed by `Django.contrib.AUTH`
17+
- `Registration` page
18+
- `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 # # Page
126+
| | |-- register.html # # 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 de#spired 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+
180+
<br />
181+
182+
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
183+
184+
<br />
185+
186+
---
187+
**[Django CoreUI Theme](https://appseed.us/product/coreui/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**

‎publish.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
python setup.py sdist ; twine check dist/*
2+
3+
twine upload .\dist\THE_GENERATED_PACKAGE

‎setup.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@
88

99
setup(
1010
name='django-admin-coreui',
11-
version='1.0.1',
11+
version='0.0.1',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,
15-
description='',
15+
description='Modern template for Django admin interface',
1616
long_description=README,
1717
long_description_content_type="text/markdown",
18-
url='https://github.com/app-generator/django-admin-coreui',
18+
url='https://appseed.us/product/coreui/django/',
1919
author='AppSeed.us',
2020
author_email='support@appseed.us',
21-
license='EULA License',
21+
license='MIT License',
2222
classifiers=[
2323
'Intended Audience :: Developers',
2424
'Intended Audience :: System Administrators',

0 commit comments

Comments
 (0)