Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/django-black-dashboard-pro
Django Starter - Black Dashboard PRO | AppSeed
https://github.com/app-generator/django-black-dashboard-pro
appseed black-dashboard dark-design django django-template django-theme
Last synced: 20 days ago
JSON representation
Django Starter - Black Dashboard PRO | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-black-dashboard-pro
- Owner: app-generator
- License: other
- Created: 2023-01-24T11:17:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T17:40:43.000Z (9 months ago)
- Last Synced: 2024-10-11T04:44:41.517Z (about 1 month ago)
- Topics: appseed, black-dashboard, dark-design, django, django-template, django-theme
- Homepage: https://appseed.us/product/black-dashboard-pro/django/
- Size: 42 KB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django Black PRO](https://appseed.us/product/black-dashboard-pro/django/)
**Django** starter styled with **[Black Dashboard PRO](https://appseed.us/product/black-dashboard-pro/django/)**, a premium `Bootstrap` Design from [Creative-Tim](https://bit.ly/3fKQZaL).
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
- 🛒 [Django Black PRO](https://appseed.us/product/black-dashboard-pro/django/) - `Product page` (contains payment links)
- 👉 [Django Black PRO](https://django-black-pro.onrender.com/) - `LIVE Demo` on Render
## Features
- `Up-to-date dependencies`
- Database: `SQLite`, PgSQL, MySql
- **Authentication**
- `Session-Based authentication`
- `Social Login`: **Github** & **Google**
- **User Extended profile**
- **API** via DRF
- DataTables
- Charts
- Celery
- File Manager
- i18n (internationalization)
- `Docker`
## Start in `Docker`
> **Step 1** - Download the [code](https://appseed.us/product/black-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
```bash
$ unzip django-black-dashboard-pro.zip
$ cd django-black-dashboard-pro
```
> **Step 2** - Start the APP in `Docker`
```bash
# Optional (kill all existing containers)
$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f
# Start the APP
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Create new `.env` from `env.sample`
The meaning of each variable can be found below:
- `DEBUG`: if `True` the app runs in develoment mode
- For production value `False` should be used
- `MYSQL` credentials
- `DB_ENGINE`, default value = `mysql`
- `DB_NAME`, default value = `appseed_db`
- `DB_HOST`, default value = `localhost`
- `DB_PORT`, default value = `3306`
- `DB_USERNAME`, default value = `appseed_db_usr`
- `DB_PASS`, default value = `pass`
- `OAuth` via Github
- `GITHUB_ID`=
- `GITHUB_SECRET`=
- `OAuth` via Google
- `GOOGLE_CLIENT_ID`=
- `GOOGLE_SECRET_KEY`=
## Manual Build
> - Download the [code](https://appseed.us/product/black-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
```bash
$ unzip django-black-dashboard-pro.zip
$ cd django-black-dashboard-pro
```
### 👉 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
```
> Create 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/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
### 👉 Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app
- Access the `registration` page and create a new user:
- `http://127.0.0.1:8000/register/`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:8000/login/`
## Start Celery (async task)
- Make sure you have a Redis Server running: `redis://localhost:6379`
- `$ redis-cli` and type `ping`
- In the base directory inside `tasks_scripts` folder you need to write your scripts file.
- Run the celery command from the CLI.
```bash
$ export DJANGO_SETTINGS_MODULE="core.settings"
$ celery -A apps.tasks worker -l info -B
```
- You will see a new route `Apps -> Tasks` in the sidebar.
- You can start and cancel any task from the UI.
## Enable Social Login
> 👉 **Github Setup** - [Create an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
- SignIN to `Github`
- Access `Settings` -> `Developer Settings` -> `OAuth Apps`
- Edit your OAuth App
- `App Name`
- `App Description`
- (mandatory) `HomePage`: `https://localhost:8000`
- (mandatory) `Authorization callback URL`: `https://localhost:8000/`
- Generate a new `secret key`
## Recompile SCSS
The SCSS/CSS files used to style the UI are saved in the `/LIB/admin_black_pro/static/assets` directory by PIP.
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.
- Copy the `static` Directory from `VENV` to `ROOT/static`
- like this, Django will use the local versions and ignore the `VENV` files
- Install dependencies via `Yarn`
- Edit `_variables.scss`
- Regenerate CSS via `gulp`
```bash
$ yarn # install modules
$ # # edit variables
$ vi static/assets/scss/black-dashboard/custom/_variables.scss
$ gulp # SCSS to CSS translation
```
The `_variables.scss` content defines the `primary` and `secondary` colors:
```scss
$default: #344675 !default; // EDIT for customization
$primary: #e14eca !default; // EDIT for customization
$secondary: #f4f5f7 !default; // EDIT for customization
$success: #00f2c3 !default; // EDIT for customization
$info: #1d8cf8 !default; // EDIT for customization
$warning: #ff8d72 !default; // EDIT for customization
$danger: #fd5d93 !default; // EDIT for customization
$black: #222a42 !default; // EDIT for customization
```
## Codebase
The project is coded using a simple and intuitive structure presented below:
```bash
< PROJECT ROOT >
|
|-- core/ # Implements app configuration
| |-- settings.py # Defines Global Settings
| |-- wsgi.py # Start the app in production
| |-- urls.py # Define URLs served by all apps/nodes
|
|-- home/ # Serves all pages from the UI Kit
|
|-- apps/
| |
| |-- common/ # Assets used by all APPS (models, helpers)
| |-- users/ # Handles Auth Flow
| |-- api/ # DRF API
| |-- charts/ # Charts APP
| |-- tables/ # DataTables APP
| |-- tasks/ # Celery App
|
|-- templates/ # Pages & Templates
|-- assets/ # Static Assets [ JS, CSS, images ]
|
|-- requirements.txt # Development modules - SQLite storage
|
|-- .env # Environment
|-- env.sample # Environment Sample
|
|-- manage.py # Django Manager File
|
|-- ************************************************************************
```
---
[Django Black PRO](https://appseed.us/product/black-dashboard-pro/django/) - Starter crafted by **[AppSeed](https://appseed.us/)**.