{"id":30799569,"url":"https://github.com/creativetimofficial/black-dashboard-flask","last_synced_at":"2025-09-05T19:51:34.569Z","repository":{"id":63959948,"uuid":"283742011","full_name":"creativetimofficial/black-dashboard-flask","owner":"creativetimofficial","description":"Black Dashboard - Flask Template | Creative-Tim","archived":false,"fork":false,"pushed_at":"2024-06-01T11:38:03.000Z","size":6573,"stargazers_count":46,"open_issues_count":2,"forks_count":225,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-08-30T23:56:20.695Z","etag":null,"topics":["creative-tim","open-source"],"latest_commit_sha":null,"homepage":"https://www.creative-tim.com/product/black-dashboard-flask","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/creativetimofficial.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-30T10:31:55.000Z","updated_at":"2025-08-27T12:59:32.000Z","dependencies_parsed_at":"2024-01-23T22:04:25.151Z","dependency_job_id":null,"html_url":"https://github.com/creativetimofficial/black-dashboard-flask","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/creativetimofficial/black-dashboard-flask","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativetimofficial%2Fblack-dashboard-flask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativetimofficial%2Fblack-dashboard-flask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativetimofficial%2Fblack-dashboard-flask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativetimofficial%2Fblack-dashboard-flask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/creativetimofficial","download_url":"https://codeload.github.com/creativetimofficial/black-dashboard-flask/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativetimofficial%2Fblack-dashboard-flask/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273812984,"owners_count":25172890,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["creative-tim","open-source"],"created_at":"2025-09-05T19:51:30.505Z","updated_at":"2025-09-05T19:51:34.561Z","avatar_url":"https://github.com/creativetimofficial.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Black Dashboard Flask](https://www.creative-tim.com/product/black-dashboard-flask) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social\u0026logo=twitter)](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)\n\n ![version](https://img.shields.io/badge/version-1.0.1-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/black-dashboard-flask.svg?maxAge=2592000)](https://github.com/creativetimofficial/black-dashboard-flask/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/black-dashboard-flask.svg?maxAge=2592000)](https://github.com/creativetimofficial/black-dashboard-flask/issues?q=is%3Aissue+is%3Aclosed) [![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/NIT-dgp/General.svg)](https://gitter.im/creative-tim-general/Lobby) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy)\n\n![Black Dashboard Flask - Admin Dashboard coded in Django.](https://github.com/creativetimofficial/black-dashboard-flask/blob/master/media/black-dashboard-flask-intro.gif)\n\n\u003cbr /\u003e\n\n\u003e Features:\n\n- ✅ `Up-to-date dependencies`\n- ✅ Black Dashboard, BS4 Design\n- ✅ `DB Tools`: SQLAlchemy ORM, `Flask-Migrate` (schema migrations)\n- ✅ `Persistence`: SQLite (dev), MySql (prod)\n- ✅ `Authentication`: Session Based, `OAuth` via Github\n- ✅ `Deployment`: Docker, Page Compression (Flask-Minify) \n\n\u003cbr /\u003e\n\n## Table of Contents\n\n* [Demo](#demo)\n* [Docker Support](#docker-support)\n* [Quick Start](#quick-start)\n* [Documentation](#documentation)\n* [File Structure](#file-structure)\n* [Browser Support](#browser-support)\n* [Resources](#resources)\n* [Reporting Issues](#reporting-issues)\n* [Technical Support or Questions](#technical-support-or-questions)\n* [Licensing](#licensing)\n* [Useful Links](#useful-links)\n\n\u003cbr /\u003e\n\n## Demo\n\n\u003e To authenticate use the default credentials ***test / pass*** or create a new user on the [registration page](https://www.creative-tim.com/live/black-dashboard-flask).\n\n- **Black Dashboard Flask** [Login Page](https://www.creative-tim.com/live/black-dashboard-flask)\n\n\u003cbr /\u003e\n\n## Docker Support\n\n\u003e Get the code\n\n```bash\n$ git clone https://github.com/app-generator/black-dashboard-flask.git\n$ cd black-dashboard-flask\n```\n\n\u003e Start the app in Docker\n\n```bash\n$ docker-compose up --build \n```\n\nVisit `http://localhost:5085` in your browser. The app should be up \u0026 running.\n\n\u003cbr /\u003e\n\n## Create/Edit `.env` file\n\nThe meaning of each variable can be found below: \n\n- `DEBUG`: if `True` the app runs in develoment mode\n  - For production value `False` should be used\n- `ASSETS_ROOT`: used in assets management\n  - default value: `/static/assets`\n- `OAuth` via Github\n  - `GITHUB_ID`=\u003cGITHUB_ID_HERE\u003e\n  - `GITHUB_SECRET`=\u003cGITHUB_SECRET_HERE\u003e \n\n\u003cbr /\u003e\n\n## Manual Build\n\n\u003e UNZIP the sources or clone the private repository. After getting the code, open a terminal and navigate to the working directory, with product source code.\n\n### 👉 Set Up for `Unix`, `MacOS` \n\n\u003e Install modules via `VENV`  \n\n```bash\n$ virtualenv env\n$ source env/bin/activate\n$ pip3 install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e Set Up Flask Environment\n\n```bash\n$ export FLASK_APP=run.py\n$ export FLASK_ENV=development\n```\n\n\u003cbr /\u003e\n\n\u003e Start the app\n\n```bash\n$ flask run\n// OR\n$ flask run --cert=adhoc # For HTTPS server\n```\n\nAt this point, the app runs at `http://127.0.0.1:5000/`. \n\n\u003cbr /\u003e\n\n### 👉 Set Up for `Windows` \n\n\u003e Install modules via `VENV` (windows) \n\n```\n$ virtualenv env\n$ .\\env\\Scripts\\activate\n$ pip3 install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e Set Up Flask Environment\n\n```bash\n$ # CMD \n$ set FLASK_APP=run.py\n$ set FLASK_ENV=development\n$\n$ # Powershell\n$ $env:FLASK_APP = \".\\run.py\"\n$ $env:FLASK_ENV = \"development\"\n```\n\n\u003cbr /\u003e\n\n\u003e Start the app\n\n```bash\n$ flask run\n// OR\n$ flask run --cert=adhoc # For HTTPS server\n```\n\nAt this point, the app runs at `http://127.0.0.1:5000/`. \n\n\u003cbr /\u003e\n\n## Recompile SCSS  \n\nThe SCSS/CSS files used to style the Ui are saved in the `apps/static/assets` directory. \nIn order to update the Ui colors (primary, secondary) this procedure needs to be followed. \n\n```bash\n$ yarn # install modules\n$ # # edit variables \n$ vi apps/static/assets/scss/black-dashboard/custom/_variables.scss \n$ gulp # SCSS to CSS translation\n```\n\nThe `_variables.scss` content defines the `primary` and `secondary` colors: \n\n```scss\n$default:       #344675 !default; // EDIT for customization\n$primary:       #e14eca !default; // EDIT for customization\n$secondary:     #f4f5f7 !default; // EDIT for customization\n$success:       #00f2c3 !default; // EDIT for customization\n$info:          #1d8cf8 !default; // EDIT for customization\n$warning:       #ff8d72 !default; // EDIT for customization\n$danger:        #fd5d93 !default; // EDIT for customization\n$black:         #222a42 !default; // EDIT for customization\n```\n\n\u003cbr /\u003e\n\n## Documentation\n\nThe documentation for the **Black Dashboard Flask** is hosted at our [website](https://demos.creative-tim.com/black-dashboard-flask/docs/1.0/getting-started/getting-started-flask.html).\n\n\u003cbr /\u003e\n\n## File Structure\n\nWithin the download you'll find the following directories and files:\n\n```bash\n\u003c PROJECT ROOT \u003e\n   |\n   |-- apps/\n   |    |\n   |    |-- home/                           # A simple app that serve HTML files\n   |    |    |-- routes.py                  # Define app routes\n   |    |\n   |    |-- authentication/                 # Handles auth routes (login and register)\n   |    |    |-- routes.py                  # Define authentication routes  \n   |    |    |-- models.py                  # Defines models  \n   |    |    |-- forms.py                   # Define auth forms (login and register) \n   |    |\n   |    |-- static/\n   |    |    |-- \u003ccss, JS, images\u003e          # CSS files, Javascripts files\n   |    |\n   |    |-- templates/                      # Templates used to render pages\n   |    |    |-- includes/                  # HTML chunks and components\n   |    |    |    |-- navigation.html       # Top menu component\n   |    |    |    |-- sidebar.html          # Sidebar component\n   |    |    |    |-- footer.html           # App Footer\n   |    |    |    |-- scripts.html          # Scripts common to all pages\n   |    |    |\n   |    |    |-- layouts/                   # Master pages\n   |    |    |    |-- base-fullscreen.html  # Used by Authentication pages\n   |    |    |    |-- base.html             # Used by common pages\n   |    |    |\n   |    |    |-- accounts/                  # Authentication pages\n   |    |    |    |-- login.html            # Login page\n   |    |    |    |-- register.html         # Register page\n   |    |    |\n   |    |    |-- home/                      # UI Kit Pages\n   |    |         |-- index.html            # Index page\n   |    |         |-- 404-page.html         # 404 page\n   |    |         |-- *.html                # All other pages\n   |    |    \n   |  config.py                             # Set up the app\n   |    __init__.py                         # Initialize the app\n   |\n   |-- requirements.txt                     # App Dependencies\n   |\n   |-- .env                                 # Inject Configuration via Environment\n   |-- run.py                               # Start the app - WSGI gateway\n   |\n   |-- ************************************************************************\n```\n\n\u003cbr /\u003e\n\n## Browser Support\n\nAt present, we officially aim to support the last two versions of the following browsers:\n\n\u003cimg src=\"https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png\" width=\"64\" height=\"64\"\u003e \u003cimg src=\"https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png\" width=\"64\" height=\"64\"\u003e \u003cimg src=\"https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png\" width=\"64\" height=\"64\"\u003e \u003cimg src=\"https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png\" width=\"64\" height=\"64\"\u003e \u003cimg src=\"https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png\" width=\"64\" height=\"64\"\u003e\n\n\u003cbr /\u003e\n\n## Resources\n\n- Demo: \u003chttps://www.creative-tim.com/live/black-dashboard-flask\u003e\n- Download Page: \u003chttps://www.creative-tim.com/product/black-dashboard-flask\u003e\n- Documentation: \u003chttps://demos.creative-tim.com/black-dashboard-flask/docs/1.0/getting-started/getting-started-flask.html\u003e\n- License Agreement: \u003chttps://www.creative-tim.com/license\u003e\n- Support: \u003chttps://www.creative-tim.com/contact-us\u003e\n- Issues: [Github Issues Page](https://github.com/creativetimofficial/black-dashboard-flask/issues)\n\n\u003cbr /\u003e\n\n## Reporting Issues\n\nWe use GitHub Issues as the official bug tracker for the **Black Dashboard Flask**. Here are some advices for our users that want to report an issue:\n\n1. Make sure that you are using the latest version of the **Black Dashboard Flask**. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).\n2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.\n3. Some issues may be browser-specific, so specifying in what browser you encountered the issue might help.\n\n\u003cbr /\u003e\n\n## Technical Support or Questions\n\nIf you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue.\n\n\u003cbr /\u003e\n\n## Licensing\n\n- Copyright 2019 - present [Creative Tim](https://www.creative-tim.com/)\n- Licensed under [Creative Tim EULA](https://www.creative-tim.com/license)\n\n\u003cbr /\u003e\n\n## Useful Links\n\n- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim\n- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)\n- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim\n- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money)\n\n\u003cbr /\u003e\n\n## Social Media\n\n- Twitter: \u003chttps://twitter.com/CreativeTim\u003e\n- Facebook: \u003chttps://www.facebook.com/CreativeTim\u003e\n- Dribbble: \u003chttps://dribbble.com/creativetim\u003e\n- Instagram: \u003chttps://www.instagram.com/CreativeTimOfficial\u003e\n\n\u003cbr /\u003e\n\n---\n[Black Dashboard Flask](https://www.creative-tim.com/product/black-dashboard-flask) - Provided by [Creative Tim](https://www.creative-tim.com/) and [AppSeed](https://appseed.us)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativetimofficial%2Fblack-dashboard-flask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreativetimofficial%2Fblack-dashboard-flask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativetimofficial%2Fblack-dashboard-flask/lists"}