Add readme, product gif, changelog
This commit is contained in:
cristij
parent
beef68e90c
commit
8d1fc33d13
24
CHANGELOG.md
24
CHANGELOG.md
@ -1,26 +1,4 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [1.0.0] 2017-06-18
|
## [1.0.0] 2018-10-14
|
||||||
### Stable Original Release
|
### Stable Original Release
|
||||||
|
|
||||||
## [2.0.0] 2018-05-01
|
|
||||||
## Vue Paper Dashboard Version 2
|
|
||||||
- Bootstrap 4 update
|
|
||||||
- Migrate components to support BS4 as well as existing scss assets
|
|
||||||
- Vue CLI 3 update
|
|
||||||
- Get rid of old webpack template and make use of newest vue-cli 3. The project has almost no configuration files and
|
|
||||||
should work out of the box if you copy paste the `src` folder into a newly scaffolded Vue CLI 3 project.
|
|
||||||
- Overall project structure improvements
|
|
||||||
- The project structure resembles a default [nuxt project structure](https://nuxtjs.org/)
|
|
||||||
We have a breakdown of
|
|
||||||
- `components` folder (only UI components)
|
|
||||||
- `pages` folder which contains pages/views
|
|
||||||
- `layout` folder which contains layout related components
|
|
||||||
- `assets` folder which contains scss, images and fonts
|
|
||||||
- `plugins` folder which has project related plugins
|
|
||||||
- `router` folder which contains routes
|
|
||||||
|
|
||||||
- Component improvements
|
|
||||||
- Use of `vue-notifyjs` for notifications
|
|
||||||
- Improvements for Sidebar. Option to declare links as children inside Sidebar slot. SSR support.
|
|
||||||
- Minor improvements for other components and SSR support for them
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2017 Cristi Jora
|
Copyright (c) 2017 Creative Tim (https://www.creative-tim.com)
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
234
README.md
234
README.md
@ -1,45 +1,211 @@
|
|||||||
# [Vue Black Dashboard](https://github.com/creativetimofficial/vue-black-dashboard)
|
# [Vue-Black Dashboard](https://demos.creative-tim.com/vue-black-dashboard) [](https://twitter.com/intent/tweet?text=Black%20Dashboard%20by%20Creative%20Tim&url=https%3A%2F%2Fdemos.creative-tim.com%2Fblack-dashboard%2Fexamples%2Fdashboard.html&via=CreativeTim)
|
||||||
|
|
||||||
> Admin dashboard based on black dashboard UI template + vue-router
|
|
||||||
|
|
||||||
This project is a vue version of [Black-dashboard](https://www.creative-tim.com/product/paper-dashboard)
|
  [](https://github.com/creativetimofficial/black-dashboard/issues/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/creativetimofficial/black-dashboard/issues/issues?q=is%3Aissue+is%3Aclosed) [](https://gitter.im/creative-tim-general/Lobby) [](https://discord.gg/E4aHAQy)
|
||||||
designed for vue js.The dashboard includes vue-router
|
|
||||||
|
|
||||||
Check the [Live Demo here](https://github.com/creativetimofficial/vue-black-dashboard).
|
|
||||||
|
|
||||||
|
|
||||||
|
Vue Black Dashboard is a beautiful Bootstrap 4 Admin Dashboard with a huge number of components built to fit together and look amazing. If you are looking for a tool to manage and visualize data about your business, this dashboard is the thing for you. It combines colors that are easy on the eye, spacious cards, beautiful typography, and graphics.
|
||||||
|
Vue Black Dashboard comes packed with all plugins that you might need inside a project and documentation on how to get started. It is light and easy to use, and also very powerful.
|
||||||
|
|
||||||
|
Vue Black Dashboard features over 16 individual components, giving you the freedom of choosing and combining. This means that there are thousands of possible combinations. All components can take variations in color, that you can easily modify using SASS files. You will save a lot of time going from prototyping to full-functional code because all elements are implemented.
|
||||||
|
We thought about everything, so this dashboard comes with 2 versions, Dark Mode and Light Mode.
|
||||||
|
|
||||||
|
We are very excited to share this dashboard with you and we look forward to hearing your feedback!
|
||||||
|
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- [Start page](https://demos.creative-tim.com/vue-black-dashboard)
|
||||||
|
- [User profile page](https://demos.creative-tim.com/vue-black-dashboard/#/profile)
|
||||||
|
- [Tables page ](https://demos.creative-tim.com/vue-black-dashboard/#/table-list)
|
||||||
|
- [Maps Page](https://demos.creative-tim.com/vue-black-dashboard/#/maps)
|
||||||
|
- [Notifications page](https://demos.creative-tim.com//vue-black-dashboard/#/notifications)
|
||||||
|
|
||||||
|
[View More](https://demos.creative-tim.com/vue-black-dashboard).
|
||||||
|
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
- Clone the repo: `git clone https://github.com/creativetimofficial/vue-black-dashboard.git`.
|
||||||
|
- [Download from Github](https://github.com/creativetimofficial/vue-black-dashboard/archive/master.zip).
|
||||||
|
- [Download from Creative Tim](https://www.creative-tim.com/product/vue-black-dashboard).
|
||||||
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
Link to [Documentation](http://vuejs.creative-tim.com/vue-black-dashboard/documentation/)
|
The documentation for the Vue Black Dashboard is hosted at our [website](https://demos.creative-tim.com/vue-black-dashboard/documentation).
|
||||||
|
|
||||||
## Build Setup
|
|
||||||
|
|
||||||
### install dependencies
|
## File Structure
|
||||||
```
|
Within the download you'll find the following directories and files:
|
||||||
npm install
|
|
||||||
```
|
|
||||||
### serve with hot reload at localhost:8080
|
|
||||||
```
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
### build for production with minification
|
|
||||||
```
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
### lint
|
|
||||||
```
|
|
||||||
npm run lint
|
|
||||||
```
|
|
||||||
## Contribution guide
|
|
||||||
* Fork the repository
|
|
||||||
* `npm install` or `yarn install`
|
|
||||||
* Make changes
|
|
||||||
* Open Pull Request
|
|
||||||
|
|
||||||
For detailed explanation on how things work, checkout the [guide](https://github.com/vuejs/vue-cli/blob/dev/docs/README.md)
|
```
|
||||||
- [CHANGELOG](./CHANGELOG.md)
|
|-- Vue Black Dashboard
|
||||||
- [version-badge](https://img.shields.io/badge/version-2.0.0-blue.svg)
|
|-- .babelrc
|
||||||
- [license-badge](https://img.shields.io/badge/license-MIT-blue.svg)
|
|-- .env
|
||||||
|
|-- .eslintrc
|
||||||
|
|-- .gitattributes
|
||||||
|
|-- .gitignore
|
||||||
|
|-- CHANGELOG.md
|
||||||
|
|-- CONTRIBUTING.md
|
||||||
|
|-- LICENSE.md
|
||||||
|
|-- README.md
|
||||||
|
|-- package.json
|
||||||
|
|-- vue.config.js
|
||||||
|
|-- src
|
||||||
|
|-- App.vue
|
||||||
|
|-- i18n.js
|
||||||
|
|-- main.js
|
||||||
|
|-- assets
|
||||||
|
| |-- css
|
||||||
|
| | |-- nucleo-icons.css
|
||||||
|
| |-- demo
|
||||||
|
| | |-- demo.css
|
||||||
|
| |-- fonts
|
||||||
|
| | |-- nucleo.eot
|
||||||
|
| | |-- nucleo.ttf
|
||||||
|
| | |-- nucleo.woff
|
||||||
|
| | |-- nucleo.woff2
|
||||||
|
| |-- sass
|
||||||
|
| |-- black-dashboard.scss
|
||||||
|
| |-- black-dashboard
|
||||||
|
| |-- bootstrap
|
||||||
|
| |-- custom
|
||||||
|
| |-- plugins
|
||||||
|
|-- components
|
||||||
|
| |-- BaseAlert.vue
|
||||||
|
| |-- BaseButton.vue
|
||||||
|
| |-- BaseCheckbox.vue
|
||||||
|
| |-- BaseDropdown.vue
|
||||||
|
| |-- BaseNav.vue
|
||||||
|
| |-- BaseTable.vue
|
||||||
|
| |-- CloseButton.vue
|
||||||
|
| |-- Modal.vue
|
||||||
|
| |-- NavbarToggleButton.vue
|
||||||
|
| |-- index.js
|
||||||
|
| |-- Cards
|
||||||
|
| | |-- Card.vue
|
||||||
|
| | |-- StatsCard.vue
|
||||||
|
| |-- Charts
|
||||||
|
| | |-- BarChart.js
|
||||||
|
| | |-- LineChart.js
|
||||||
|
| | |-- config.js
|
||||||
|
| | |-- utils.js
|
||||||
|
| |-- Inputs
|
||||||
|
| | |-- BaseInput.vue
|
||||||
|
| |-- NotificationPlugin
|
||||||
|
| | |-- Notification.vue
|
||||||
|
| | |-- Notifications.vue
|
||||||
|
| | |-- index.js
|
||||||
|
| |-- SidebarPlugin
|
||||||
|
| |-- SideBar.vue
|
||||||
|
| |-- SidebarLink.vue
|
||||||
|
| |-- index.js
|
||||||
|
|-- directives
|
||||||
|
| |-- click-ouside.js
|
||||||
|
|-- layout
|
||||||
|
| |-- dashboard
|
||||||
|
| |-- Content.vue
|
||||||
|
| |-- ContentFooter.vue
|
||||||
|
| |-- DashboardLayout.vue
|
||||||
|
| |-- MobileMenu.vue
|
||||||
|
| |-- SidebarSharePlugin.vue
|
||||||
|
| |-- TopNavbar.vue
|
||||||
|
|-- locales
|
||||||
|
| |-- ar.json
|
||||||
|
| |-- en.json
|
||||||
|
|-- pages
|
||||||
|
| |-- Dashboard.vue
|
||||||
|
| |-- Icons.vue
|
||||||
|
| |-- Maps.vue
|
||||||
|
| |-- NotFoundPage.vue
|
||||||
|
| |-- Notifications.vue
|
||||||
|
| |-- Profile.vue
|
||||||
|
| |-- TableList.vue
|
||||||
|
| |-- Typography.vue
|
||||||
|
| |-- Dashboard
|
||||||
|
| | |-- TaskList.vue
|
||||||
|
| | |-- UserTable.vue
|
||||||
|
| |-- Notifications
|
||||||
|
| | |-- NotificationTemplate.vue
|
||||||
|
| |-- Profile
|
||||||
|
| |-- EditProfileForm.vue
|
||||||
|
| |-- UserCard.vue
|
||||||
|
|-- plugins
|
||||||
|
| |-- RTLPlugin.js
|
||||||
|
| |-- blackDashboard.js
|
||||||
|
| |-- globalComponents.js
|
||||||
|
| |-- globalDirectives.js
|
||||||
|
| |-- liveDemo.js
|
||||||
|
|-- router
|
||||||
|
|-- index.js
|
||||||
|
|-- routes.js
|
||||||
|
|
||||||
## License
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Browser Support
|
||||||
|
|
||||||
|
At present, we officially aim to support the last two versions of the following browsers:
|
||||||
|
|
||||||
|
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Reporting Issues
|
||||||
|
|
||||||
|
We use GitHub Issues as the official bug tracker for the Vue Black Dashboard. 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 Vue Black Dashboard. 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 2018 Creative Tim (https://www.creative-tim.com/)
|
||||||
|
|
||||||
|
- Licensed under MIT (https://github.com/creativetimofficial/vue-black-dashboard/issues/blob/master/LICENSE.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 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: <https://twitter.com/CreativeTim>
|
||||||
|
|
||||||
|
Facebook: <https://www.facebook.com/CreativeTim>
|
||||||
|
|
||||||
|
Dribbble: <https://dribbble.com/creativetim>
|
||||||
|
|
||||||
|
Google+: <https://plus.google.com/+CreativetimPage>
|
||||||
|
|
||||||
|
Instagram: <https://instagram.com/creativetimofficial>
|
||||||
|
|
||||||
[MIT](https://github.com/creativetimofficial/vue-black-dashboard/LICENCE.md)
|
|
||||||
|
|||||||
BIN
src/assets/demo/product-gif.gif
Normal file
BIN
src/assets/demo/product-gif.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.2 MiB |
Loading…
x
Reference in New Issue
Block a user