Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativetimofficial/ct-black-dashboard-pro-django
Black Dashboard PRO - Premium Django Template | Creative-Tim
https://github.com/creativetimofficial/ct-black-dashboard-pro-django
admin-dashboard appseed creative-tim dark-theme django
Last synced: 7 days ago
JSON representation
Black Dashboard PRO - Premium Django Template | Creative-Tim
- Host: GitHub
- URL: https://github.com/creativetimofficial/ct-black-dashboard-pro-django
- Owner: creativetimofficial
- License: other
- Created: 2020-06-16T11:02:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-16T04:18:53.000Z (over 1 year ago)
- Last Synced: 2024-08-01T20:47:38.819Z (4 months ago)
- Topics: admin-dashboard, appseed, creative-tim, dark-theme, django
- Language: Python
- Homepage: https://www.creative-tim.com/product/black-dashboard-pro-django
- Size: 1.28 MB
- Stars: 23
- Watchers: 7
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Black Dashboard PRO Django](https://www.creative-tim.com/product/black-dashboard-pro-django) [](https://twitter.com/home?status=Material%20Dashboard,%20a%20free%20Material%20Bootstrap%204%20Admin%20Template%20%E2%9D%A4%EF%B8%8F%20https%3A//bit.ly/2Lyat1Y%20%23bootstrap%20%23material%20%23design%20%23developers%20%23freebie%20%20via%20%40CreativeTim)
 [](https://github.com/creativetimofficial/ct-black-dashboard-pro-django/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/creativetimofficial/ct-black-dashboard-pro-django/issues?q=is%3Aissue+is%3Aclosed) [](https://gitter.im/creative-tim-general/Lobby) [](https://discord.gg/E4aHAQy)
**Django Template** crafted on top of **[Black Dashboard PRO](https://www.creative-tim.com/product/black-dashboard-pro-django)**, a premium Bootstrap 4 design. Start your development with a modern, dark-themed Bootstrap 4 Admin template for **Django**. It features a huge number of components built to fit together and look fantastic. If you want to code faster, with a smooth workflow, then you should try this template carefully developed with **Django**, a well-known `Python Framework`.
> **NOTE**: This product `requires a License` in order to access the theme. During the purchase, a `GitHub Access TOKEN` is provided.
## Features:
- ✅ `Up-to-date Dependencies`
- ✅ `Design`: [Django Theme Black](https://github.com/app-generator/django-admin-black-pro) - `PRO Version`
- ✅ `Sections` covered by the design:
- ✅ **Admin section** (reserved for superusers)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- ✅ **All Pages** available in for ordinary users
- ✅ `Docker`
- 🚀 Deployment: `CI/CD` flow via `Render`
- [Django Black PRO - Go LIVE](https://www.youtube.com/watch?v=5BgutmR77F8) - `video presentation`
[](https://www.creative-tim.com/product/black-dashboard-pro-django)
## Table of Contents
* [Demo](#demo)
* [Quick Start](#quick-start)
* [Documentation](#documentation)
* [File Structure](#file-structure)
* [Browser Support](#browser-support)
* [Resources](#resources)
* [Reporting Issues](#reporting-issues)
* [Technical Support or Questions](#technical-support-or-questions)
* [Licensing](#licensing)
* [Useful Links](#useful-links)
## Demo
> To authenticate use the default credentials ***test / PaSS_123*** or create a new user on the **registration page**.
- **Black Dashboard PRO Django** [Login Page](https://www.creative-tim.com/live/black-dashboard-pro-django)
## Quick start
> UNZIP the sources or clone this repository. After getting the code, open a terminal and navigate to the working directory, with product source code.
> Export `GITHUB_TOKEN` in the environment. The value is provided during purchase.
This is required because the project has a private REPO dependency: `github.com/app-generator/priv-django-admin-black-pro`
```bash
$ export GITHUB_TOKEN='TOKEN_HERE' # for Linux, Mac
$ set GITHUB_TOKEN='TOKEN_HERE' # Windows CMD
$ $env:GITHUB_TOKEN = 'TOKEN_HERE' # Windows powerShell
```
> 👉 Install modules via `VENV`.
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
> 👉 Edit the `.env` using the template `.env.sample`.
```env
# True for development, False for production
DEBUG=True
```
> 👉 Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> 👉 Create the Superuser
```bash
$ python manage.py createsuperuser
```
> 👉 Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
## Documentation
The documentation for the **Black Dashboard PRO Django** is hosted at our [website](https://demos.creative-tim.com/black-dashboard-pro-django/docs/1.0/getting-started/getting-started-django.html).
## 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
| |-- includes #
| |-- custom-footer.py # Custom Footer
|
|-- 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
< LIBRARY_ROOT > # This exists in ENV: LIB/admin_black_pro
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- login.html # Sign IN Page
| | |-- register.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 # Index Page (presentation)
| |-- settings.html # Settings Page
| |-- dashboard.html # Dashboard 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 footer.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 `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
- Source PATH: `/LIB/admin_black_pro/includes/footer.html`
- Destination PATH: `home/templates/includes/footer.html`
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location:
`home/templates/includes/custom_footer.html`
By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix).
In order to use it, simply rename it to `footer.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](https://render.com/)
- 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 `Update Existing Resources` button.
- After that your deployment will start automatically.
At this point, the product should be LIVE.
## Browser Support
At present, we officially aim to support the last two versions of the following browsers:
## Resources
- Demo:
- Download Page:
- Documentation:
- License Agreement:
- Support:
- Issues: [Github Issues Page](https://github.com/creativetimofficial/ct-black-dashboard-pro-django/issues)
## Reporting Issues
We use GitHub Issues as the official bug tracker for the **Black Dashboard PRO Django**. Here are some advices for our users that want to report an issue:
1. Make sure that you are using the latest version of the **Black Dashboard PRO Django**. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser-specific, so specifying in what browser you encountered the issue might help.
## Technical Support or Questions
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue.
## Licensing
- Copyright 2019 - present [Creative Tim](https://www.creative-tim.com/)
- Licensed under [Creative Tim EULA](https://www.creative-tim.com/license)
## Useful Links
- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim
- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money)
## Social Media
- Twitter:
- Facebook:
- Dribbble:
- Instagram:
---
[Black Dashboard PRO Django](https://www.creative-tim.com/product/black-dashboard-pro-django) - Provided by [Creative Tim](https://www.creative-tim.com/) and [AppSeed](https://appseed.us).