-
Notifications
You must be signed in to change notification settings - Fork 377
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Readme almost done - to change the thumbnail for the Paper Dashboar…
…d React - Deleted unneccessary stuff - Added CHANGELOG, ISSUE_TEMPLATE and LICENSE - Added github assets - Deleted API KEY from maps
- Loading branch information
Manu
committed
Oct 10, 2018
1 parent
88881c9
commit 0c026f6
Showing
17 changed files
with
269 additions
and
6,542 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
## [1.0.0] 2018-10-12 | ||
### Original Release | ||
- Added Reactstrap as base framework | ||
- Added design from Paper Dashboard 2 by Creative Tim |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Prerequisites | ||
|
||
Please answer the following questions for yourself before submitting an issue. | ||
|
||
- [ ] I am running the latest version | ||
- [ ] I checked the documentation and found no answer | ||
- [ ] I checked to make sure that this issue has not already been filed | ||
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects) | ||
|
||
# Expected Behavior | ||
|
||
Please describe the behavior you are expecting | ||
|
||
# Current Behavior | ||
|
||
What is the current behavior? | ||
|
||
# Failure Information (for bugs) | ||
|
||
Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template. | ||
|
||
## Steps to Reproduce | ||
|
||
Please provide detailed steps for reproducing the issue. | ||
|
||
1. step 1 | ||
2. step 2 | ||
3. you get it... | ||
|
||
## Context | ||
|
||
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. | ||
|
||
* Device: | ||
* Operating System: | ||
* Browser and Version: | ||
|
||
## Failure Logs | ||
|
||
Please include any relevant log snippets or files here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Creative Tim | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,202 @@ | ||
![Product Gif](./paper-dashboard-react.gif) | ||
# [Paper Dashboard React](https://demos.creative-tim.com/paper-dashboard-react/#/dashboard) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fdemos.creative-tim.com%2Fpaper-dashboard-react%2F%23%2Fdashboard&text=Paper%20Dashboard%20React%20by%20Creative%20Tim%20%7C%20Free%20React%20Admin%20Template&original_referer=https%3A%2F%2Fdemos.creative-tim.com%2Fpaper-dashboard-react%2F&via=creativetim&hashtags=react%2Ccreativetim%2Cpaper%2Cdashboard%2Cbootstrap%2Creactstrap%2Creactjs) | ||
|
||
|
||
|
||
![version](https://img.shields.io/badge/version-1.0.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/paper-dashboard-react.svg?maxAge=2592000)]() [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/paper-dashboard-react.svg?maxAge=2592000)]() [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy) | ||
|
||
![Product Gif](./src/assets/github/paper-dashboard-react.gif) | ||
|
||
If you are a react developer or a react website owner that needs to work within a dashboard and want to have a pretty sight while doing so, Paper Dashboard React is for you. Paper Dashboard React is a Bootstrap Admin Panel which combines soft colours with beautiful typography and spacious cards and graphics. It is a powerful tool, but it is light and easy to use. It has enough features to allow you to get the job done, but it is not crowded to the point where you can't find the files for a specific plugin. | ||
|
||
We like consistency and design that blends into its purpose. Paper Dashboard React is a perfect example of our most thoughtful work. It combines over a dozen components and plugins, while looking like everything fits together. For an easy start or inspiration for you project, we have also create a set of example pages, like the user settings or usage graphics. | ||
|
||
Paper Dashboard React is built using the same design language as [Paper Dashboard 2](https://www.creative-tim.com/product/paper-dashboard-2). | ||
|
||
**Bootstrap 4 Support** Paper Dashboard React is built on top of the much awaited Bootstrap 4 and uses the most used react framework that implements the Bootstrap 4 components on react, reactstrap. This makes starting a new project very simple. It also provides benefits if you are already working on a Bootstrap 4 and/or reactstrap project; you can just import the Paper Dashboard React style over it. Most of the elements have been redesigned; but if you are using an element we have not touched, it will fall back to the Bootstrap default. | ||
|
||
**Example Pages** We wanted to fully display the power of this dashboard, so the kit comes packed with examples showing you how to use the components. | ||
|
||
## Table of Contents | ||
|
||
* [Versions](#versions) | ||
* [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) | ||
|
||
|
||
## Versions | ||
|
||
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/paper-dashboard-2) | ||
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/react.svg" width="60" height="60" />](https://www.creative-tim.com/product/paper-dashboard-react) | ||
|
||
|
||
| HTML | React | | ||
| --- | --- | | ||
| [![Paper Dashboard 2 HTML](https://s3.amazonaws.com/creativetim_bucket/products/86/thumb/opt_pd2_thumbnail.jpg)](https://www.creative-tim.com/product/paper-dashboard-2) | [![Paper Dashboard React](https://s3.amazonaws.com/creativetim_bucket/products/97/thumb/opt_pdr_thumbnail.jpg)](https://www.creative-tim.com/product/paper-dashboard-react) | | ||
|
||
## Demo | ||
|
||
| Dashboard | User Profile | Tables | Maps | Notification | | ||
| --- | --- | --- | --- | --- | | ||
| [![Start page](./src/assets/github/paper-dashboard-react-dashboard-page.png)](https://demos.creative-tim.com/paper-dashboard-react/#/dashboard) | [![User profile page](./src/assets/github/paper-dashboard-react-user-page.png)](https://demos.creative-tim.com/paper-dashboard-react/#/user-page) | [![Tables page ](./src/assets/github/paper-dashboard-react-table-page.png)](https://demos.creative-tim.com/paper-dashboard-react/#/table-list) | [![Maps Page](./src/assets/github/paper-dashboard-react-maps-page.png)](https://demos.creative-tim.com/paper-dashboard-react/#/maps) | [![Notification page](./src/assets/github/paper-dashboard-react-notifications-page.png)](https://demos.creative-tim.com/paper-dashboard-react/#/notifications) | ||
|
||
[View More](https://demos.creative-tim.com/paper-dashboard-react/#/dashboard). | ||
|
||
|
||
## Quick start | ||
|
||
Quick start options: | ||
|
||
- `npm i paper-dashboard-react` | ||
- Clone the repo: `git clone https://github.com/creativetimofficial/paper-dashboard-react.git`. | ||
- [Download from Github](https://github.com/creativetimofficial/paper-dashboard-react/archive/master.zip). | ||
- [Download from Creative Tim](https://www.creative-tim.com/product/paper-dashboard-react). | ||
|
||
|
||
## Documentation | ||
The documentation for the Paper Dashboard React is hosted at our [website](https://demos.creative-tim.com/paper-dashboard-react/#/documentation/tutorial). | ||
|
||
|
||
## File Structure | ||
|
||
Within the download you'll find the following directories and files: | ||
|
||
``` | ||
├── CHANGELOG.md | ||
├── ISSUE_TEMPLATE.md | ||
├── LICENSE.md | ||
├── README.md | ||
├── package.json | ||
├── public | ||
│ ├── favicon.ico | ||
│ ├── index.html | ||
│ └── manifest.json | ||
└── src | ||
├── index.js | ||
├── logo-white.svg | ||
├── logo.svg | ||
├── assets | ||
│ ├── demo | ||
│ ├── fonts | ||
│ ├── github | ||
│ ├── img | ||
│ │ └── faces | ||
│ └── scss | ||
│ ├── paper-dashboard | ||
│ │ ├── cards | ||
│ │ ├── mixins | ||
│ │ └── plugins | ||
│ └── paper-dashboard.scss | ||
├── components | ||
│ ├── CardElements | ||
│ │ ├── CardAuthor.jsx | ||
│ │ ├── CardCategory.jsx | ||
│ │ └── CardSocials.jsx | ||
│ ├── CustomButton | ||
│ │ └── CustomButton.jsx | ||
│ ├── CustomCheckbox | ||
│ │ └── SimpleCheckbox.jsx | ||
│ ├── CustomRadio | ||
│ │ └── CustomRadio.jsx | ||
│ ├── FixedPlugin | ||
│ │ └── FixedPlugin.jsx | ||
│ ├── Footer | ||
│ │ └── Footer.jsx | ||
│ ├── FormInputs | ||
│ │ └── FormInputs.jsx | ||
│ ├── Header | ||
│ │ └── Header.jsx | ||
│ ├── Sidebar | ||
│ │ └── Sidebar.jsx | ||
│ ├── Stats | ||
│ │ └── Stats.jsx | ||
│ ├── Tasks | ||
│ │ └── Tasks.jsx | ||
│ └── index.js | ||
├── layouts | ||
│ └── Dashboard | ||
│ └── Dashboard.jsx | ||
├── routes | ||
│ ├── dashboard.jsx | ||
│ └── index.jsx | ||
├── variables | ||
│ ├── charts.jsx | ||
│ ├── general.jsx | ||
│ └── icons.jsx | ||
└── views | ||
├── Dashboard | ||
│ └── Dashboard.jsx | ||
├── Icons | ||
│ └── Icons.jsx | ||
├── Maps | ||
│ └── Maps.jsx | ||
├── Notifications | ||
│ └── Notifications.jsx | ||
├── TableList | ||
│ └── TableList.jsx | ||
├── Typography | ||
│ └── Typography.jsx | ||
└── UserPage | ||
└── UserPage.jsx | ||
``` | ||
|
||
## 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"> | ||
|
||
|
||
## Resources | ||
- Demo: https://demos.creative-tim.com/paper-dashboard-react/#/dashboard | ||
- Download Page: https://www.creative-tim.com/product/paper-dashboard-react | ||
- Documentation: https://demos.creative-tim.com/paper-dashboard-react/#/documentation/tutorial | ||
- License Agreement: https://www.creative-tim.com/license | ||
- Support: https://www.creative-tim.com/contact-us | ||
- Issues: [Github Issues Page](https://github.com/creativetimofficial/paper-dashboard-react/issues) | ||
|
||
## Reporting Issues | ||
We use GitHub Issues as the official bug tracker for the Paper Dashboard React. 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 Paper Dashboard React. 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/paper-dashboard-react/blob/master/LICENSE.md) | ||
|
||
## Useful Links | ||
|
||
More products from Creative Tim: <https://www.creative-tim.com/products> | ||
|
||
Tutorials: <https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w> | ||
|
||
Freebies: <https://www.creative-tim.com/products> | ||
|
||
Affiliate Program (earn money): <https://www.creative-tim.com/affiliates/new> | ||
|
||
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> |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.