Skip to content

Commit ed68839

Browse files
app-generatorapp-generator
committed
Release v0.0.4
1 parent 76dbd95 commit ed68839

File tree

17,244 files changed

+79947
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

17,244 files changed

+79947
-1
lines changed

‎CHANGELOG.md‎

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

3+
## [0.0.4] 2024-04-28
4+
### Changes
5+
6+
- Remove Node Modules from ASSETS
7+
38
## [0.0.3] 2024-04-28
49
### Changes
510

‎django-admin-coreui-0.0.3/LICENSE.md‎

Lines changed: 21 additions & 0 deletions
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.

‎django-admin-coreui-0.0.3/MANIFEST.in‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
include LICENSE
2+
include README.rst
3+
recursive-include admin_coreui/static *
4+
recursive-include admin_coreui/templates *
5+
recursive-include docs *

‎django-admin-coreui-0.0.3/PKG-INFO‎

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
Metadata-Version: 2.1
2+
Name: django-admin-coreui
3+
Version: 0.0.3
4+
Summary: Modern template for Django admin interface
5+
Home-page: https://appseed.us/product/coreui/django/
6+
Author: AppSeed.us
7+
Author-email: support@appseed.us
8+
License: MIT License
9+
Platform: UNKNOWN
10+
Classifier: Intended Audience :: Developers
11+
Classifier: Intended Audience :: System Administrators
12+
Classifier: License :: OSI Approved :: MIT License
13+
Classifier: Operating System :: OS Independent
14+
Classifier: Programming Language :: Python
15+
Classifier: Programming Language :: Python :: 2.6
16+
Classifier: Programming Language :: Python :: 2.7
17+
Classifier: Programming Language :: Python :: 3.2
18+
Classifier: Programming Language :: Python :: 3.3
19+
Classifier: Programming Language :: Python :: 3.4
20+
Classifier: Programming Language :: Python :: 3.5
21+
Classifier: Programming Language :: Python :: 3.6
22+
Classifier: Environment :: Web Environment
23+
Classifier: Topic :: Software Development
24+
Classifier: Topic :: Software Development :: User Interfaces
25+
Description-Content-Type: text/markdown
26+
License-File: LICENSE.md
27+
28+
# [Django CoreUI Theme](https://appseed.us/product/coreui/django/)
29+
30+
Modern template for **Django Admin Interface** coded on top of **[CoreUI](https://appseed.us/product/coreui/django/)**, an iconic Bootstrap Dashboard template.
31+
32+
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
33+
34+
<br>
35+
36+
**Links & Resources**
37+
38+
- [Django CoreUI](https://appseed.us/product/coreui/django/) - `Product` that uses the library
39+
- `Features`: Fully-configured, `CI/CD` via Render
40+
- UI Kit: `CoreUI`
41+
- **Sections Covered**:
42+
- `Admin Section`, reserved for `superusers`
43+
- `All pages` managed by `Django.contrib.AUTH`
44+
- `Registration` page
45+
- `Misc pages`: colors, icons, typography, blank-page
46+
47+
<br />
48+
49+
![CoreUI - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171336361-b125ca1d-8936-4f4a-b662-9e45ee25f404.png)
50+
51+
<br />
52+
53+
## Why `Django CoreUI Theme`
54+
55+
- Modern [Bootstrap](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
56+
- `Responsive Interface`
57+
- `Minimal Template` overriding
58+
- `Easy integration`
59+
60+
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.
61+
Fits many screen resolutions from small mobile devices to large desktops.
62+
63+
<br />
64+
65+
## How to use it
66+
67+
<br />
68+
69+
> **Install the package** via `PIP`
70+
71+
```bash
72+
$ pip install django-admin-coreui
73+
// OR
74+
$ pip install git+https://github.com/app-generator/django-admin-coreui.git
75+
```
76+
77+
<br />
78+
79+
> Add `admin_coreui` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
80+
81+
```python
82+
INSTALLED_APPS = (
83+
...
84+
'admin_coreui.apps.AdminCoreuiConfig',
85+
'django.contrib.admin',
86+
)
87+
```
88+
89+
<br />
90+
91+
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
92+
93+
```python
94+
LOGIN_REDIRECT_URL = '/'
95+
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
96+
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
97+
```
98+
99+
<br />
100+
101+
> Add `admin_coreui` urls in your Django Project `urls.py` file
102+
103+
```python
104+
from django.urls import path, include
105+
106+
urlpatterns = [
107+
...
108+
path('', include('admin_coreui.urls')),
109+
]
110+
```
111+
112+
<br />
113+
114+
> **Collect static** if you are in `production environment`:
115+
116+
```bash
117+
$ python manage.py collectstatic
118+
```
119+
120+
<br />
121+
122+
> **Start the app**
123+
124+
```bash
125+
$ # Set up the database
126+
$ python manage.py makemigrations
127+
$ python manage.py migrate
128+
$
129+
$ # Create the superuser
130+
$ python manage.py createsuperuser
131+
$
132+
$ # Start the application (development mode)
133+
$ python manage.py runserver # default port 8000
134+
```
135+
136+
Access the `admin` section in the browser: `http://127.0.0.1:8000/`
137+
138+
<br />
139+
140+
## How to Customize
141+
142+
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.
143+
The theme used to style this starter provides the following files:
144+
145+
```bash
146+
# This exists in ENV: LIB/admin_coreui
147+
< UI_LIBRARY_ROOT >
148+
|
149+
|-- templates/ # Root Templates Folder
150+
| |
151+
| |-- accounts/
152+
| | |-- login.html # Sign IN Page
153+
| | |-- register.html # Sign UP Page
154+
| |
155+
| |-- includes/
156+
| | |-- footer.html # Footer component
157+
| | |-- sidebar.html # Sidebar component
158+
| | |-- navigation.html # Navigation Bar
159+
| | |-- scripts.html # Scripts Component
160+
| |
161+
| |-- layouts/
162+
| | |-- base.html # Masterpage
163+
| | |-- base-auth.html # Masterpage for Auth Pages
164+
| |
165+
| |-- pages/
166+
| |-- index.html # Dashboard Page
167+
| |-- calendar.html # Profile Page
168+
| |-- *.html # All other pages
169+
|
170+
|-- ************************************************************************
171+
```
172+
173+
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.
174+
175+
For instance, if we want to customize the `footer.html` these are the steps:
176+
177+
- `Step 1`: create the `templates` DIRECTORY inside your app
178+
- `Step 2`: configure the project to use this new template directory
179+
- Edit `settings.py` TEMPLATES section
180+
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
181+
- Source PATH: `<YOUR_ENV>/LIB/admin_coreui/templates/includes/footer.html`
182+
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
183+
- Edit the `footer.html` (Destination PATH)
184+
185+
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
186+
187+
In a similar way, all other files and components can be customized easily.
188+
189+
<br />
190+
191+
192+
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
193+
194+
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.
195+
196+
> Features:
197+
198+
- `Up-to-date Dependencies`
199+
- `Design`: `Django Theme Material` (PRO Version)
200+
- `Sections` covered by the design:
201+
- **Admin section** (reserved for superusers)
202+
- **Authentication**: `Django.contrib.AUTH`, Registration
203+
- **All Pages** available in for ordinary users
204+
- `Docker`, `Deployment`:
205+
- `CI/CD` flow via `Render`
206+
207+
<br />
208+
209+
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
210+
211+
<br />
212+
213+
---
214+
**[Django CoreUI Theme](https://appseed.us/product/coreui/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
215+
216+

0 commit comments

Comments
 (0)