Skip to content

Commit

Permalink
v1.0.12 - Docs & Product Links
Browse files Browse the repository at this point in the history
  • Loading branch information
@app-generator
app-generator committed Nov 6, 2024
1 parent 225e94a commit 6c3f6f0
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 165 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# CHANGELOG

## [1.0.12] 2024-11-06
### Changes

- Update [Django Admin Datta Able - Documentation](https://app-generator.dev/docs/products/django-libs/theme-datta-able.html) Link
- Update [Django Admin Datta Able - Sample Product](https://app-generator.dev/product/datta-able/django/) Link
- Added [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) Link

## [1.0.11] 2024-09-17
### Changes

Expand Down
171 changes: 9 additions & 162 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# [Django Admin Datta](https://appseed.us/product/datta-able/django/)
# [Django Datta Able](https://app-generator.dev/docs/products/django-libs/theme-datta-able.html)

Modern template for **Django** that covers `Admin Section`, all authentication pages (registration included) crafted on top of **[Datta Able](https://appseed.us/product/datta-able/django/)**,
an open-source `Bootstrap` design from [CodedThemes](https://bit.ly/37fF9RT).
Modern template for **Django Admin**, Auth Pages (registration included) crafted on top of **Datta Able Dashboard**, an open-source **Bootstrap** design.

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

<br />

**Links & Resources**
## **Features**

- [Django Datta Able](https://appseed.us/product/datta-able/django/) - `Product page`
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: **Datta Able** (open-source, Bootstrap 4 version) by [CodedThemes](https://bit.ly/37fF9RT)
- Design: Datta Able (Bootstrap)
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
Expand All @@ -20,161 +19,9 @@ an open-source `Bootstrap` design from [CodedThemes](https://bit.ly/37fF9RT).

<br />

![Datta Able (enhaced with dark mode) - Open-Source Seed project generated by AppSeed.](https://user-images.githubusercontent.com/51070104/176118649-7233ffbc-6118-4f56-8cda-baa81d256877.png)

<br />

## Why [Django Datta Able](https://appseed.us/product/datta-able/django/)

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

<br />

## How to use it

<br />

> **Install the package** via `PIP`
```bash
$ pip install django-admin-datta
// OR
$ pip install git+https://github.com/app-generator/django-admin-datta.git
```

<br />

> Add `admin_datta` 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_datta.apps.AdminDattaConfig',
'django.contrib.admin',
)
```

<br />

> 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'
```

<br />

> Add `admin_datta` urls in your Django Project `urls.py` file
```python
from django.urls import path, include

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

<br />

> **Collect static** if you are in `production environment`:
```bash
$ python manage.py collectstatic
```

<br />

> **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/`

<br />

## 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:

```bash
# This exists in ENV: LIB/admin_datta
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- auth-signin.html # Sign IN Page
| | |-- auth-signup.html # Sign UP Page
| |
| |-- includes/
| | |-- footer.html # Footer component
| | |-- sidebar.html # Sidebar component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| | |-- base-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- profile.html # Profile Page
| |-- *.html # All other pages
|
|-- ************************************************************************
```

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 `index.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: `<YOUR_ENV>/LIB/admin_datta/templates/pages/index.html`
- Destination PATH: `YOUR_APP/templates/pages/index.html`
- Edit the `index.html` (Destination PATH)

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

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

<br />

## [Datta Able](https://appseed.us/product/datta-able-pro/django/) `PRO Version`

> For more components, pages and priority on support, feel free to take a look at this **Django** starter:
Designed for those who like bold elements and beautiful websites, **[Datta Able](https://appseed.us/product/datta-able-pro/django/)** is the most stylish Admin Design compare to all other Bootstrap Templates.
It comes with high feature-rich pages and components with fully developer-centric code.

- [Django Datta PRO](https://appseed.us/product/datta-able-pro/django/) - product page
- `Enhanced UI` - more pages and components
- `Priority` on support

<br >

![Datta Able PRO - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/170474361-a58da82b-fff9-4a59-81a8-7ab99f478f48.png)
![Django Datta Able - Modern template for Django Admin Section crafted on top of a modern Bootstrap Design.](https://user-images.githubusercontent.com/51070104/176118649-7233ffbc-6118-4f56-8cda-baa81d256877.png)

<br />

---
**[Django Admin Datta](https://appseed.us/product/datta-able/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
**[Django Datta Able](https://app-generator.dev/docs/products/django-libs/theme-datta-able.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**
6 changes: 3 additions & 3 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

setup(
name='django-admin-datta',
version='1.0.11',
version='1.0.12',
zip_safe=False,
packages=find_packages(),
include_package_data=True,
description='Modern template for Django admin interface',
description='Modern template for Django Admin - Datta Able Design',
long_description=README,
long_description_content_type="text/markdown",
url='https://appseed.us/product/datta-able/django/',
url='https://app-generator.dev/docs/products/django-libs/theme-datta-able.html',
author='AppSeed.us',
author_email='[email protected]',
license='MIT License',
Expand Down

0 comments on commit 6c3f6f0

Please sign in to comment.