1
0
mirror of https://github.com/tabler/tabler.git synced 2025-12-21 17:34:25 +04:00

Merge pull request #44 from tabler/revert-43-master

Revert "Update README for content / readability "
This commit is contained in:
Paweł Kuna
2018-04-04 10:49:10 +02:00
committed by GitHub

View File

@@ -1,31 +1,31 @@
# Tabler # Tabler
Premium and Open Source dashboard template with responsive and high quality UI. Premium and Open Source dashboard template with responsive and high quality UI.
<hr>
<a href="https://www.npmjs.com/package/tabler-ui"><img src="https://img.shields.io/npm/dt/tabler-ui.svg" alt="Total Downloads"></a> <a href="https://github.com/tabler/tabler/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/tabler-ui.svg" alt="License"></a> <a href="https://github.com/tabler/tabler/releases"><img src="https://img.shields.io/npm/v/tabler-ui.svg" alt="Latest Release"></a> <a href="https://david-dm.org/tabler/tabler?type=dev"><img src="https://img.shields.io/david/dev/tabler/tabler.svg" alt="devDependency Status"></a> <a href="https://www.npmjs.com/package/tabler-ui"><img src="https://img.shields.io/npm/dt/tabler-ui.svg" alt="Total Downloads"></a> <a href="https://github.com/tabler/tabler/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/tabler-ui.svg" alt="License"></a> <a href="https://github.com/tabler/tabler/releases"><img src="https://img.shields.io/npm/v/tabler-ui.svg" alt="Latest Release"></a> <a href="https://david-dm.org/tabler/tabler?type=dev"><img src="https://img.shields.io/david/dev/tabler/tabler.svg" alt="devDependency Status"></a>
<hr>
<strong><a href="https://tabler.github.io/demo/">View Demo</a> | <a href="https://github.com/tabler/tabler/archive/master.zip">Download ZIP</a></strong> <strong><a href="https://tabler.github.io/demo/">View Demo</a> | <a href="https://github.com/tabler/tabler/archive/master.zip">Download ZIP</a></strong>
<br><br> <br><br>
![Tabler preview](https://tabler.github.io/assets/images/dashboard.png) ![Tabler preview](https://tabler.github.io/assets/images/dashboard.png)
<hr>
## Features ## Features
<img src="https://tabler.github.io/assets/images/features/features-2.png" width="400" align="right" style="max-width: 50%"> <img src="https://tabler.github.io/assets/images/features/features-2.png" width="400" align="right" style="max-width: 50%">
Weve created this admin panel for anyone who wants to improve upon our templates based upon ready-made and modular components. Our mission is to truly create an user-experience that's second-to-none among our peers. Our goal as a company is to deliver effective templating solutions that can integrate into any software solution whether they be large or small. The only requirement is basic HTML and CSS knowledge! Start using tabler today! As a reward, you'll be able to manage and visualize different types of data in the easiest possible way! Weve created this admin panel for everyone who wants to create any template based on our ready components. Our mission is to deliver a user-friendly, clear and easy administration panel, that can be used by both, simple websites and sophisticated systems. The only requirement is a basic HTML and CSS knowledge, as a reward, you'll be able to manage and visualize different types of data in the easiest possible way!
<hr>
* **Responsive:** With support for mobile, tablet and desktop it doesnt matter what device youre using. Tabler is responsive in all major browsers. * **Responsive:** With support for mobile, tablet and desktop it doesnt matter what device youre using. Tabler is responsive in all major browsers.
* **Cross Browser:** Our theme works perfectly with: Latest Chrome, Firefox+, Latest Safari, Opera, Internet Explorer 10+ and mobile browsers. Were working hard to support them. * **Cross Browser:** Our theme works perfectly with: Latest Chrome, Firefox+, Latest Safari, Opera, Internet Explorer 10+ and mobile browsers. Were working hard to support them.
* **HTML5 & CSS3:** We only use modern web technologies like HTML5 and CSS3. Our theme includes some subtile CSS3 animations so you will get anyones attention. * **HTML5 & CSS3:** We only use modern web technologies like HTML5 and CSS3. Our theme includes some subtile CSS3 animations so you will get anyones attention.
* **Clean Code:** We strictly followed Bootstraps guidelines to make your integration as easy as possible. All code is handwritten and W3C valid. * **Clean Code:** We strictly followed Bootstraps guidelines to make your integration as easy as possible. All code is handwritten and W3c valid.
* **Demo pages**: Tabler features over 20 individual pages featuring various components, giving you the freedom of choosing and combining. All components can have variation in color and styling, that can easily be modified using Sass. The sky is the limit! * **Demo pages**: Tabler features over 20 individual pages featuring various components, giving you the freedom of choosing and combining. All components can have variation in color and styling, that can easily be modified using Sass. The sky is the limit!
<hr>
## Documentation ## Documentation
For full documentation, visit [tabler.github.io/tabler/docs](https://tabler.github.io/tabler/docs/index.html). For full documentation, visit [tabler.github.io/tabler/docs](https://tabler.github.io/tabler/docs/index.html).
<hr>
## Getting Started ## Getting Started
### [Download ZIP](https://github.com/tabler/tabler/archive/dev.zip) or Git Clone ### [Download ZIP](https://github.com/tabler/tabler/archive/dev.zip) or Git Clone
@@ -33,7 +33,7 @@ For full documentation, visit [tabler.github.io/tabler/docs](https://tabler.gith
``` ```
git clone https://github.com/tabler/tabler.git git clone https://github.com/tabler/tabler.git
``` ```
<hr>
### Setup environment ### Setup environment
To use our build system and run documentation locally, you'll need a copy of Tabler's source files and Node. Follow the steps below: To use our build system and run documentation locally, you'll need a copy of Tabler's source files and Node. Follow the steps below:
@@ -41,11 +41,11 @@ To use our build system and run documentation locally, you'll need a copy of Tab
1. [Download and install Node.js](https://nodejs.org/download/), which is used to manage our dependencies. 1. [Download and install Node.js](https://nodejs.org/download/), which is used to manage our dependencies.
2. Navigate to the root `/tabler` directory and run `npm install` to install local dependencies listed in `package.json`. 2. Navigate to the root `/tabler` directory and run `npm install` to install local dependencies listed in `package.json`.
3. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/), install [Bundler](https://bundler.io/) with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as Jekyll and plugins. 3. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/), install [Bundler](https://bundler.io/) with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as Jekyll and plugins.
<hr>
**Windows users:** Read [this guide](https://jekyllrb.com/docs/windows/) to get Jekyll up and running without problems. **Windows users:** Read [this guide](https://jekyllrb.com/docs/windows/) to get Jekyll up and running without problems.
When completed, you'll be able to run the various commands provided in the command line. When completed, you'll be able to run the various commands provided in the command line.
<hr>
### Build Tabler ### Build Tabler
1. From the root `/tabler` directory, run `npm run serve` in the command line. 1. From the root `/tabler` directory, run `npm run serve` in the command line.
@@ -53,17 +53,17 @@ When completed, you'll be able to run the various commands provided in the comma
3. Any change in `/src` directory will build application and refresh the page. 3. Any change in `/src` directory will build application and refresh the page.
**Warning!** all changes made in `_site/` folder would be overwritten on application build. **Warning!** all changes made in `_site/` folder would be overwritten on application build.
<hr>
## Bugs and feature requests ## Bugs and feature requests
Have a bug or a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). Have a bug or a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
<hr>
## Browser Support ## Browser Support
![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) ![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | 11+ ✔ | 9.1+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11+ ✔ | 9.1+ ✔ | Latest ✔ |
<hr>
## Creators ## Creators
**Paweł Kuna** **Paweł Kuna**
@@ -71,7 +71,7 @@ Latest ✔ | Latest ✔ | Latest ✔ | 11+ ✔ | 9.1+ ✔ | Latest ✔ |
- <https://twitter.com/codecalm> - <https://twitter.com/codecalm>
- <https://github.com/codecalm> - <https://github.com/codecalm>
- <https://codecalm.net> - <https://codecalm.net>
<hr>
## Copyright and license ## Copyright and license
Code and documentation copyright 2018 the [Tabler Authors](https://github.com/tabler/tabler/graphs/contributors) and [codecalm.net](https://codecalm.net). Code released under the [MIT License](https://github.com/tabler/tabler/blob/master/LICENSE). Code and documentation copyright 2018 the [Tabler Authors](https://github.com/tabler/tabler/graphs/contributors) and [codecalm.net](https://codecalm.net). Code released under the [MIT License](https://github.com/tabler/tabler/blob/master/LICENSE).