Skip to content

Commit 9bb867d

Browse files
author
Manu
committed
- Readme should now be done
1 parent 4f6ed28 commit 9bb867d

1 file changed

Lines changed: 82 additions & 51 deletions

File tree

‎README.md‎

Lines changed: 82 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# [Blk• Design System](http://demos.creative-tim.com/blk-design-system/index.html) [![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE]
1+
# [Blk• Design System React](https://demos.creative-tim.com/blk-design-system-react) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/home?status=Material%20Kit%20PRO%20is%20a%20Bootstrap%20UI%20Kit%20with%20a%20fresh,%20new%20design%20inspired%20by%20Google's%20Material%20Design%20%E2%9D%A4%EF%B8%8Fhttps%3A//demos.creative-tim.com/material-kit-pro/presentation.html%20%23bootstrap%20%23material%20%23design%20%23uikit%20%23premium%20%20via%20%40CreativeTim)
22

3-
![alt text](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/blk-design-system/opt_blk_thumbnail.jpg "Blk• Design System")
43

4+
![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/blk-design-system-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/blk-design-system-react/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/blk-design-system-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/blk-design-system-react/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)
5+
6+
7+
![Product Presentation Image](https://s3.amazonaws.com/creativetim_bucket/products/147/original/opt_blkds_react_thumbnail.jpg)
58

69
**[Blk• Design System React](http://demos.creative-tim.com/blk-design-system-react/)** is a responsive Bootstrap 4 kit, developed using [React](https://reactjs.org/), [Reactstrap](https://reactstrap.github.io/) and [create-react-app](https://facebook.github.io/create-react-app/), and it is provided for free by Creative Tim. It is a beautiful cross-platform UI kit featuring over 70 elements and 3 templates.
710

8-
Now will help you create a clean and simple website that is a perfect fit for today's black design. It is built using the 12 column grid system, with components designed to fit together perfectly. It makes use of bold colours, beautiful typography, clear photography and spacious arrangements.
11+
Blk• Design System React will help you create a clean and simple website that is a perfect fit for today's black design. It is built using the 12 column grid system, with components designed to fit together perfectly. It makes use of bold colours, beautiful typography, clear photography and spacious arrangements.
912

1013
## Complex Documentation
1114

@@ -15,55 +18,61 @@ Each element is well presented in a very complex documentation. You can read mor
1518

1619
Blk• Design System React is built on top of the much awaited Bootstrap 4 (Reactstrap). This makes starting a new project very simple. It also provides benefits if you are already working on a Bootstrap 4 or Reactstrap project; you can just import the Blk• Design System 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.
1720

18-
## Table of contents
1921

20-
* [Getting Started](#getting-started)
21-
* [Example Pages](#example-pages)
22+
## Table of Contents
23+
24+
* [Versions](#versions)
25+
* [Demo](#demo)
26+
* [Quick Start](#quick-start)
2227
* [Documentation](#documentation)
23-
* [Tutorial](#tutorial)
2428
* [File Structure](#file-structure)
2529
* [Browser Support](#browser-support)
26-
* [Technical Support or Questions](#technical-support-or-questions)
30+
* [Resources](#resources)
31+
* [Reporting Issues](#reporting-issues)
32+
* [Licensing](#licensing)
2733
* [Useful Links](#useful-links)
2834

29-
## Getting Started
3035

31-
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.
36+
## Versions
3237

33-
1. Download the project's zip
34-
2. Make sure you have node.js (https://nodejs.org/en/) installed
35-
3. Type `npm install` in terminal/console in the source folder where `package.json` is located
36-
4. You will find all the branding colors inside `assets/scss/blk-design-system/custom/_variables.scss`. You can change them with a `HEX` value or with other predefined variables.
37-
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
38-
6. Run in terminal `gulp default` for opening the Dashboard Page (default) of the product.
38+
[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/html-logo.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/material-kit?ref=blkdsr-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/react-logo.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/blk-design-system-react?ref=blkdsr-readme)[<img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/sketch-logo.jpg" width="60" height="60" />](https://github.com/creativetimofficial/blk-design-system-sketch/tree/sketch)
3939

40-
## Example Pages
4140

42-
We wanted to fully display the power of this kit, so the kit comes packed with examples showing you how to use the components. Inside the product you will find:
4341

44-
+ [Live Preview](http://demos.creative-tim.com/blk-design-system/index.html)
45-
+ [Profile Page](http://demos.creative-tim.com/blk-design-system/examples/profile-page.html)
46-
+ [Register Page](http://demos.creative-tim.com/blk-design-system/examples/register-page.html)
47-
+ [Landing Page](http://demos.creative-tim.com/blk-design-system/examples/landing-page.html)
4842

49-
## Documentation
5043

51-
The documentation for the Blk• Design System is hosted at our [website](https://demos.creative-tim.com/blk-design-system/docs/1.0/getting-started/overview.html).
5244

53-
## Tutorial
45+
| HTML | React |
46+
| --- | --- |
47+
| [![BLK Design System HTML](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system/opt_blk_thumbnail.jpg?raw=true)](https://www.creative-tim.com/product/blk-design-system) | [![BLK Design System React](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/blk-design-system-react.jpeg?raw=true)](https://www.creative-tim.com/product/blk-design-system-react)
5448

55-
In order for you to easily be able to use the Blk• Design System, we have created a tutorial page. It shows the structure for the files inside the archive and how to import them. It then features every components with a description and example fr how to use it. You can see the details here ().
49+
## Demo
5650

57-
## Coming soon
51+
| Buttons | Inputs | Navbars |
52+
| --- | --- | --- |
53+
| [![Buttons](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/buttons.png?raw=true)](https://demos.creative-tim.com/blk-design-system-react/#/) | [![Inputs](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/inputs.png?raw=true)](https://demos.creative-tim.com/blk-design-system-react/#/) | [![Navbar](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/navbars.png?raw=true)](https://demos.creative-tim.com/blk-design-system-react/#/)
5854

59-
- Vue.js
60-
- Angular
61-
- React
62-
- Sketch
63-
- Photoshop
55+
| Login Page | Landing Page | Profile Page |
56+
| --- | --- | --- |
57+
| [![Register Page](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/blk-design-system-react/register-page.png)](https://demos.creative-tim.com/blk-design-system-react/#/register-page) | [![Landing Page](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/landing-page.png?raw=true)](https://demos.creative-tim.com/blk-design-system-react/#/landing-page) | [![Profile Page](https://github.com/creativetimofficial/public-assets/blob/master/blk-design-system-react/profile-page.png?raw=true)](https://demos.creative-tim.com/blk-design-system-react/#/profile-page)
6458

65-
## File Structure
59+
[View More](https://demos.creative-tim.com/blk-design-system-react)
6660

61+
62+
## Quick start
63+
64+
- `npm i blk-design-system-react`
65+
- [Download from Github](https://github.com/creativetimofficial/blk-design-system-react/archive/master.zip).
66+
- [Download from Creative Tim](https://www.creative-tim.com/product/blk-design-system-react).
67+
- Install with [Bower](https://bower.io/): ```bower install blk-design-system-react```.
68+
- Clone the repo: `git clone https://github.com/creativetimofficial/blk-design-system-react.git`.
69+
70+
71+
## Documentation
72+
The documentation for the BLK Design System React is hosted at our [website](https://demos.creative-tim.com/blk-design-system-react/#/documentation/overview).
73+
74+
75+
## File Structure
6776
Within the download you'll find the following directories and files:
6877

6978
```
@@ -137,39 +146,61 @@ Blk• Design System React
137146
└── RegisterPage.jsx
138147
```
139148

149+
140150
## Browser Support
141151

142152
At present, we officially aim to support the last two versions of the following browsers:
143153

144-
<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">
154+
<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/chrome-logo.png?raw=true" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/firefox-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/edge-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/safari-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/opera-logo.png" width="64" height="64">
145155

146-
## Technical Support or Questions
147156

148-
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.
149157

150-
## Useful Links
158+
## Resources
159+
- Demo: <https://demos.creative-tim.com/blk-design-system-react/#/>
160+
- Download Page: <https://www.creative-tim.com/product/blk-design-system-react>
161+
- Documentation: <https://demos.creative-tim.com/blk-design-system-react/#/documentation/overview>
162+
- License Agreement: <https://www.creative-tim.com/license>
163+
- Support: <https://www.creative-tim.com/contact-us>
164+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/blk-design-system-react/issues)
165+
- **Dashboards:**
151166

152-
- More products from Creative Tim: <https://www.creative-tim.com/bootstrap-themes>
167+
| HTML | React | Vue |
168+
| --- | --- | --- |
169+
| [![Black Dashboard HTML](https://github.com/creativetimofficial/public-assets/blob/master/black-dashboard/black-dashboard.jpg?raw=true)](https://www.creative-tim.com/product/black-dashboard) | [![Black Dashboard React](https://github.com/creativetimofficial/public-assets/blob/master/black-dashboard-react/black-dashboard-react.jpg?raw=true)](https://www.creative-tim.com/product/black-dashboard-react) | [![Vue Black Dashboard](https://github.com/creativetimofficial/public-assets/blob/master/vue-black-dashboard/vue-black-dashboard.jpg?raw=true)](https://www.creative-tim.com/product/vue-black-dashboard) |
153170

154-
- Tutorials: <https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w>
171+
## Reporting Issues
155172

156-
- Freebies: <http://www.creative-tim.com/products>
173+
We use GitHub Issues as the official bug tracker for the BLK Design System. Here are some advices for our users that want to report an issue:
157174

158-
- Affiliate Program (earn money): <http://www.creative-tim.com/affiliates/new>
175+
1. Make sure that you are using the latest version of the BLK Design System. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/?ref=blkdsr-readme).
176+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
177+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
159178

160-
## Social Media:
179+
## Licensing
180+
181+
- Copyright 2018 Creative Tim (https://www.creative-tim.com/?ref=blkdsr-readme)
182+
183+
- Licensed under MIT (https://github.com/creativetimofficial/blk-design-system-react/blob/master/LICENSE.md)
184+
185+
## Useful Links
161186

162-
* Twitter: <https://twitter.com/CreativeTim>
187+
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
188+
- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money)
189+
- [Blog Creative Tim](http://blog.creative-tim.com/)
190+
- [Free Products](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim
191+
- [Premium Products](https://www.creative-tim.com/bootstrap-themes/premium) from Creative Tim
192+
- [React Products](https://www.creative-tim.com/bootstrap-themes/react-themes) from Creative Tim
193+
- [Angular Products](https://www.creative-tim.com/bootstrap-themes/angular-themes) from Creative Tim
194+
- [VueJS Products](https://www.creative-tim.com/bootstrap-themes/vuejs-themes) from Creative Tim
195+
- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim
196+
- Check our Bundles [here](https://www.creative-tim.com/bundles?ref="mk-github-readme")
163197

164-
* Facebook: <https://www.facebook.com/CreativeTim>
198+
### Social Media
165199

166-
* Dribbble: <https://dribbble.com/creativetim>
200+
Twitter: <https://twitter.com/CreativeTim>
167201

168-
* Google+: <https://plus.google.com/+CreativetimPage>
202+
Facebook: <https://www.facebook.com/CreativeTim>
169203

170-
* Instagram: <https://instagram.com/creativetimofficial>
204+
Dribbble: <https://dribbble.com/creativetim>
171205

172-
[CHANGELOG]: ./CHANGELOG.md
173-
[LICENSE]: ./LICENSE
174-
[version-badge]: https://img.shields.io/badge/version-1.0.0-blue.svg
175-
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
206+
Instagram: <https://www.instagram.com/CreativeTimOfficial>

0 commit comments

Comments
 (0)