Giter Site home page Giter Site logo

danielmaangi / django-datta-able Goto Github PK

View Code? Open in Web Editor NEW

This project forked from app-generator/django-datta-able

0.0 0.0 0.0 3.57 MB

Datta Able - Open-Source Django Dashboard | AppSeed

Home Page: https://appseed.us/product/datta-able/django/

License: Other

Shell 0.05% JavaScript 2.68% Python 2.70% CSS 68.05% HTML 25.74% Dockerfile 0.09% SCSS 0.69%

django-datta-able's Introduction

Open-source Django Dashboard provided 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 high feature-rich pages and components with fully developer-centric code - design from CodedThemes.


Features

Have questions? Contact Support (Email & Discord) provided by AppSeed

Free Version PRO Version Custom Development
โœ“ Django 4.2.9 Everything in Free, plus: Everything in PRO, plus:
โœ“ Bootstrap 4 UI โœ… PRO Bootstrap 5 UI, Dark-Mode โœ… 1mo Custom Development
โœ“ API Generator โœ… OAuth Google, GitHub โœ… Team: PM, Developer, Tester
โœ“ Simple DataTables โœ… API, Charts โœ… Weekly Sprints
โœ“ Docker โœ… Enhanced DataTables โœ… Technical Specs
โœ“ CI/CD Flow via Render โœ… Celery (async tasks) โœ… Documentation
- โœ… Media Files Manager โœ… 30 days Delivery Warranty
- โœ… Extended User Profiles -
- โœ… Automated e2e Tests -
- โœ… Private REPO Access -
- โœ… PRO Support - Email & Discord -
- โœ… AWS, DO, Azure Deploy Assistance -
------------------------------------ ------------------------------------ ------------------------------------
โœ“ LIVE Demo ๐Ÿš€ LIVE Demo ๐Ÿ›’ Order: $3,999 (GUMROAD)

Datta Able (enhanced with dark mode) - Open-Source Seed project generated by AppSeed.


Start with Docker

๐Ÿ‘‰ Step 1 - Download the code from the GH repository (using GIT)

$ git clone https://github.com/app-generator/django-datta-able.git
$ cd django-datta-able

๐Ÿ‘‰ Step 2 - Start the APP in Docker

$ 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

$ git clone https://github.com/app-generator/django-datta-able.git
$ cd django-datta-able

๐Ÿ‘‰ Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Generate API

$ python manage.py generate-api -f

Start the APP

$ 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/.


๐Ÿ‘‰ Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the APP

$ 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/.



Codebase Structure

The project is coded using a simple and intuitive structure presented below:

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

# 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: <YOUR_ENV>/LIB/admin_black_pro/pages/index.html
    • Destination PATH: <PROJECT_ROOT>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.


Deploy on Render

  • Create a Blueprint instance
  • 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.
  • After that, your deployment will start automatically.

At this point, the product should be LIVE.


Datta Able 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 - product page
    • โœ… Enhanced UI - more pages and components
    • โœ… Priority on support

Datta Able PRO - Full-Stack Starter generated by AppSeed.



Datta Able Django - Open-source starter provided by AppSeed.

django-datta-able's People

Contributors

app-generator avatar admin-dashboards avatar benfaruna avatar dependabot[bot] avatar mominur-helios avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.