Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/django-v5-datta-able
Django v5.x - Datta Able (free starter) | AppSeed
https://github.com/app-generator/django-v5-datta-able
datta-able django django-5-release django-5-starter django-5-template django-5x django-v5 django-v5-docker django-v5-release django-v5x django5 django5-dashboard django5-docker django5-free-samples django5-freebies django5-opensource-samples django5-starter django5-template
Last synced: 20 days ago
JSON representation
Django v5.x - Datta Able (free starter) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-v5-datta-able
- Owner: app-generator
- License: other
- Created: 2023-10-01T10:54:12.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-05T09:13:14.000Z (about 1 year ago)
- Last Synced: 2024-10-11T04:44:28.814Z (about 1 month ago)
- Topics: datta-able, django, django-5-release, django-5-starter, django-5-template, django-5x, django-v5, django-v5-docker, django-v5-release, django-v5x, django5, django5-dashboard, django5-docker, django5-free-samples, django5-freebies, django5-opensource-samples, django5-starter, django5-template
- Language: CSS
- Homepage: https://django-v5-datta.onrender.com
- Size: 3 MB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Django v5 [Datta Able](https://appseed.us/product/datta-able/django/)
Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by `AppSeed` on top of a modern design. **Datta Able** Bootstrap Lite is the most stylized Bootstrap 4 Template, among all other Lite/Free admin templates in the market. It comes with highly feature-rich pages and components with fully developer-centric code.
- 👉 [Django v5.x Datta Able](https://django-v5-datta.onrender.com) - `LIVE demo`
- 🚀 See more **[Open-source Django 5 Starters](https://github.com/app-generator/django-5-release-free-samples)**
> Features:
- ✅ `Up-to-date Dependencies` - **Django v5.x**
- ✅ `Design`: [Django Datta Able](https://github.com/app-generator/django-admin-datta) - `Free Version` from **[CodedThemes](https://codedthemes.com/?ref=appseed)**
- ✅ `Sections` covered by the design:
- ✅ **Admin section** (reserved for superusers)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- ✅ **All Pages** available in for ordinary users
- ✅ [Dynamic DataTables](https://appseed.us/developer-tools/django-dynamic-datatables/) `Integration`
- URI: `/datatb/product/`
- ✅ `Docker` with **LIVE Reload** (Python Code & Templates)
- 🚀 `CI/CD` flow via `Render`
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/django-v5-datta-able.git
$ cd django-v5-datta-able
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ chmod +x entrypoint.sh
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Environment
Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below:
- `DEBUG`: if `True` the app runs in development mode
- For production value `False` should be used
- For `MySql` persistence
- Install the DB Driver: `pip install mysqlclient`
- Create DB and assign a new user (full rights)
- Edit `.env` to match the DB, user, and password
## Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/django-v5-datta-able.git
$ cd django-v5-datta-able
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> Generate API
```bash
$ python manage.py generate-api -f
```
> Start the APP
```bash
$ python manage.py createsuperuser # create the admin
$ python manage.py runserver # start the project
```
At this point, the app runs at `http://127.0.0.1:8000/`.
## **Deploy on Render**
- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on the `Update Existing Resources` button.
- Edit the Environment and [specify the PYTHON_VERSION](https://render.com/docs/python-version)
- Version `3.11.5` was used for **[this deployment](https://django-v5-datta.onrender.com/)**
- After that, your deployment will start automatically.
At this point, the product should be LIVE.
## `Codebase` Structure
The project is coded using a simple and intuitive structure presented below:
```bash
< PROJECT ROOT >
|
|-- core/
| |-- settings.py # Project Configuration
| |-- urls.py # Project Routing
|
|-- home/
| |-- views.py # APP Views
| |-- urls.py # APP Routing
| |-- models.py # APP Models
| |-- tests.py # Tests
| |-- templates/ # Theme Customisation
| |-- pages #
| |-- custom-index.py # Custom Dashboard
|
|-- requirements.txt # Project Dependencies
|
|-- env.sample # ENV Configuration (default values)
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```
## How to Customize
When a template file is loaded in the controller, `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 the `home` app
- ✅ `Step 2`: configure the project to use this new template directory
- `core/settings.py` TEMPLATES section
- ✅ `Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
- Source PATH: `/LIB/admin_black_pro/pages/index.html`
- Destination PATH: `home/templates/pages/index.html`
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom dashboard` can be found at this location:
`home/templates/pages/custom-index.html`
By default, this file is unused because the `theme` expects `index.html` (without the `custom-` prefix).
In order to use it, simply rename it to `index.html`. Like this, the default version shipped in the library is ignored by Django.
In a similar way, all other files and components can be customized easily.
## [Datta Able Django](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 amazing starter:
Designed for those who like bold elements and beautiful websites, **Datta Able** is the most stylish Bootstrap 4 Admin Template compare to all other Bootstrap admin 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
---
[Datta Able Django](https://appseed.us/product/datta-able/django/) - Open-source starter provided by **[AppSeed](https://appseed.us/)**.