Black_Dashboard_Pro/README.md

90 lines
3.6 KiB
Markdown

# Thank you for purchasing Black Dashboard PRO <3
## Docs and Examples
Please check the official documentation in `docs/1.0/getting-started/introduction.html` or directly to this link: https://demos.creative-tim.com/marketplace/black-dashboard-pro/docs/1.0/getting-started/introduction.html
## Getting Started
We've also included an optional Gulp file to help you get started with theme customization. You'll need to install Node.js and Gulp before using our included gulpfile.js.
1. Download the project's zip
2. Make sure you have node.js (https://nodejs.org/en/) installed
3. Type `npm install` in terminal/console in the source folder where `package.json` is located
4. You will find all the branding colors inside `assets/scss/black-dashboard/custom/variables/_brand.scss`. You can change them with a `HEX` value or with other predefined variables from`assets/scss/black-dashboard/custom/variables/_colors.scss`
5. Run in terminal `gulp compile-scss` for a single compilation or `gulp watch` for continous compilation of the changes that you make in `*.scss` files. This command should be run in the same folder where `gulpfile.js` and `package.json` are located
6. Run in terminal `gulp default` for opening the Dashboard Page (default) of the product.
## Support
If you experience any problems with the above, or if you think you've found a bug with your theme - please don't hesitate to reach out to https://www.creative-tim.com/support thanks!!
### What's included
Within the download you'll find the following directories and files:
```
├── CHANGELOG.md
├── README.md
├── assets
│   ├── css
│   │   ├── black-dashboard.css
│   │   ├── black-dashboard.css.map
│   │   ├── black-dashboard.min.css
│   │   └── nucleo-icons.css
│   ├── demo
│   │   ├── demo.css
│   │   └── demo.js
│   ├── fonts/
│   ├── img/
│   ├── js/
│   │   ├── black-dashboard.js
│   │   ├── black-dashboard.js.map
│   │   ├── black-dashboard.min.js
│   │   ├── core/
│   │   └── plugins/
│   └── scss
│   ├── black-dashboard/
│   │   ├── cards/
│   │   ├── mixins/
│   │   └── plugins/
│   └── black-dashboard.scss
├── docs/
├── examples/
│   ├── calendar.html
│   ├── charts.html
│   ├── components/
│   │   ├── buttons.html
│   │   ├── grid.html
│   │   ├── icons.html
│   │   ├── notifications.html
│   │   ├── panels.html
│   │   ├── sweet-alert.html
│   │   └── typography.html
│   ├── dashboard.html
│   ├── forms/
│   │   ├── extended.html
│   │   ├── regular.html
│   │   ├── validation.html
│   │   └── wizard.html
│   ├── maps/
│   │   ├── fullscreen.html
│   │   ├── google.html
│   │   └── vector.html
│   ├── pages/
│   │   ├── lock.html
│   │   ├── login.html
│   │   ├── pricing.html
│   │   ├── register.html
│   │   ├── rtl.html
│   │   ├── timeline.html
│   │   └── user.html
│   ├── tables/
│   │   ├── datatables.net.html
│   │   ├── extended.html
│   │   └── regular.html
│   └── widgets.html
├── gulpfile.js
└── package.json
```