Skip to content

Commit 060d594

Browse files
committed
Release v1.0.0 - CleanUP & DOCS Update
1 parent f3ae7ac commit 060d594

File tree

6 files changed

+19
-63
lines changed

6 files changed

+19
-63
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11

2+
## [1.0.0] 2022-10-19
3+
### Improvements
4+
5+
- Update DOCS
6+
- CleanUp README
7+
28
## [0.0.6] 2022-09-19
39
### Merge PRs
410

README.md

Lines changed: 12 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
1-
# Django Admin Volt
1+
# [Django Admin Volt](https://github.com/app-generator/django-admin-volt)
22

3-
Modern template for **Django Admin Interface** coded on top of **[Volt Dashboard](https://django-volt-dashboard.appseed-srv1.com/)** (free version). Volt Dashboard is a free and open source Bootstrap 5 Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS.
3+
Modern template for **Django Admin Interface** coded on top of **Volt Dashboard**, an open-source `Boostrap 5` design.
44

5-
> Originally coded by [Iman Karimi](https://github.com/imankarimi), actively supported by [AppSeed](https://appseed.us/) via Github (issues tracker) and [Discord](https://discord.gg/fZC6hup).
5+
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
66
77
<br>
88

99
**Links & Resources**
1010

11-
- [Django Volt Dashboard](https://appseed.us/admin-dashboards/django-dashboard-volt) - Open-source starter that uses the same UI Kit
11+
- [Django Volt Dashboard](https://appseed.us/product/volt-dashboard/django/) - free starter with the same design
1212
- [Django Volt Dashboard](https://django-volt-dashboard.appseed-srv1.com/) - LIVE Demo
13-
- More [Django Dashboards](https://appseed.us/admin-dashboards/django) provided by AppSeed
1413

1514
<br />
1615

17-
## Why Django Admin Volt?
16+
## Why `Django Admin Volt`
1817

19-
- Bootstrap 5 Design: **[Volt Dashboard](https://django-volt-dashboard.appseed-srv1.com/)** (Free version) provided by **Themesberg**
20-
- New fresh look
21-
- Responsive mobile interface
22-
- Useful admin home page
23-
- Minimal template overriding
24-
- Easy integration
18+
- Modern `Bootstrap 5` Design
19+
- `Responsive Interface`
20+
- `Minimal Template` overriding
21+
- `Easy integration`
2522

2623
<br />
2724

@@ -55,55 +52,6 @@ $ pip install git+https://github.com/app-generator/django-admin-volt.git
5552

5653
<br />
5754

58-
> All programs you add in **INSTALLED_APPS** should look like this: **APP_NAME.apps.APP_NAMEConfig**.
59-
60-
In this feature, we considered that each App can have its own icon, so we ask users to use this feature according to the method. Also in apps.py of each program according to the example add the icon field in the corresponding class. You can go **[here](https://fontawesome.com/v4.7/icons/)** to use more icons
61-
62-
63-
```python
64-
65-
from django.apps import AppConfig
66-
67-
class APP_NAMEConfig(AppConfig):
68-
name = 'APP_NAME'
69-
icon = 'ICON_CLASS' # for example: icon = 'fa fa-users'
70-
```
71-
72-
<br />
73-
74-
> Make sure `django.template.context_processors.request` context processor is enabled in settings.py (Django 1.8+ way):
75-
76-
```python
77-
78-
TEMPLATES = [
79-
{
80-
'BACKEND': 'django.template.backends.django.DjangoTemplates',
81-
'DIRS': [],
82-
'APP_DIRS': True,
83-
'OPTIONS': {
84-
'context_processors': [
85-
...
86-
'django.template.context_processors.request',
87-
...
88-
],
89-
},
90-
},
91-
]
92-
```
93-
94-
:warning: **Warning!!**
95-
* Before Django 1.8 you should specify context processors different way. Also use ``django.core.context_processors.request`` instead of ``django.template.context_processors.request``.
96-
97-
```python
98-
from django.conf import global_settings
99-
100-
TEMPLATE_CONTEXT_PROCESSORS = global_settings.TEMPLATE_CONTEXT_PROCESSORS + (
101-
'django.core.context_processors.request',
102-
)
103-
```
104-
105-
<br />
106-
10755
> Collect static if you are in production environment:
10856
10957
```bash
@@ -134,5 +82,7 @@ Access the `admin` section in the browser: `http://127.0.0.1:8000/`
13482

13583
![Django Admin Volt - Main Django Dashboard screen.](https://user-images.githubusercontent.com/51070104/136143245-85cd8af7-43ea-4956-8fcd-45e307171943.png)
13684

85+
<br />
86+
13787
---
138-
**Django Admin Volt** - Provided by **AppSeed [App Generator](https://appseed.us/)**
88+
**[Django Admin Volt](https://github.com/app-generator/django-admin-volt)** - Provided by **[AppSeed](https://appseed.us/)**

screenshots/screen_shot_1.png

-106 KB
Binary file not shown.

screenshots/screen_shot_2.png

-105 KB
Binary file not shown.

screenshots/screen_shot_3.png

-94.1 KB
Binary file not shown.

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-volt',
11-
version='0.0.6',
11+
version='1.0.0',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,

0 commit comments

Comments
 (0)