README.md 7.6 KB
Newer Older
C
chomik 已提交
1
# Tabler
P
Paweł Kuna 已提交
2

M
Martyna 已提交
3
A premium and open source dashboard template with a responsive and high-quality UI.
P
Paweł Kuna 已提交
4

P
Paweł Kuna 已提交
5
<strong><a href="https://preview-dev.tabler.io">View Demo</a> | <a href="https://github.com/tabler/tabler-react">View React Version</a> | <a href="https://github.com/tabler/tabler/archive/master.zip">Download ZIP</a> | <a href="https://join.slack.com/t/tabler-ui/shared_invite/enQtMzQxMTYxODk5NDYwLWU4Y2FiNWYxN2UyNWUzOTBjNmU0ZGM2ZDViMjQzMWMyZWM0ZDFkMGRhZGFiYzFhZjM1NmIxOGQ2ZDUwZjlhMTU">Join us on Slack</a></strong>
C
chomik 已提交
6

C
codecalm 已提交
7
![Tabler preview](/static/tabler-preview.png?raw=true)
C
chomik 已提交
8

A
Anton 已提交
9 10
## Status

C
codecalm 已提交
11
<a href="https://www.npmjs.com/package/tabler"><a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/tabler/backers/badge.svg"/></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/tabler/sponsors/badge.svg"/></a> <img src="https://img.shields.io/npm/dt/tabler.svg" alt="Total Downloads"></a> <a href="https://github.com/tabler/tabler/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/tabler.svg" alt="License"></a> <a href="https://github.com/tabler/tabler/releases"><img src="https://img.shields.io/npm/v/tabler.svg" alt="Latest Release"></a>
A
Anton 已提交
12

C
codecalm 已提交
13 14 15
[![Backers on Open Collective](https://opencollective.com/tabler/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/tabler/sponsors/badge.svg)](#sponsors)

C
chomik 已提交
16 17
## Features

M
Martyna 已提交
18
We've created this admin panel for everyone who wants to create templates based on our pre-made 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 basic HTML and CSS (and some [Liquid](https://github.com/Shopify/liquid/wiki)) knowledge — as a reward, you'll be able to manage and visualise different types of data in the easiest possible way!
C
chomik 已提交
19

M
Martyna 已提交
20 21 22 23 24
* **Responsive:** With the support for mobile, tablet and desktop displays, it doesn’t matter what device you’re using. Tabler is responsive in all major browsers.
* **Cross Browser:** Our theme works perfectly with the latest Chrome, Firefox+, latest Safari, Opera, Edge and mobile browsers. We work hard to to provide continuous support for them.
* **HTML5 & CSS3:** We use only modern web technologies, such as HTML5 and CSS3. Our theme includes some subtle CSS3 animations, which will help you attract attention.
* **Clean Code:** We followed Bootstrap’s guidelines carefully to make your integration as easy as possible. All code is handwritten and W3C valid.
* **Demo pages**: Tabler features over 20 individual pages using various components, which gives you the freedom to choose and combine. All components can vary in color and styling that you can easily modify using Sass. Sky is the limit!
C
chomik 已提交
25 26
* **Single Page Application versions:** [Tabler React](https://github.com/tabler/tabler-react) has React components for Tabler.

C
codecalm 已提交
27 28 29 30
## Sponsor Tabler

<a href="https://github.com/sponsors/codecalm" target="_blank"><img src="/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>

A
Anton 已提交
31
## Setup environment
C
chomik 已提交
32

M
Martyna 已提交
33
To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below:
A
Anton 已提交
34 35 36

1. [Install Node.js](https://nodejs.org/download/), which we use to manage our dependencies.
2. Navigate to the root `/tabler` directory and run `npm install` to install our local dependencies listed in `package.json`.
M
Martyna 已提交
37 38
3. [Install Ruby](https://ruby-lang.org/en/documentation/installation/) - the recommended version is [2.5.5](https://cache.ruby-lang.org/pub/ruby/2.5/ruby-2.5.5.tar.gz).
4. [Install Bundler](https://bundler.io) with `gem install bundler` and finally run `bundle install`. It will install all Ruby dependencies, such as [Jekyll and plugins](https://jekyllrb.com).
39 40

**Windows users**:
C
codecalm 已提交
41

M
Martyna 已提交
42 43
1. [Install Git](https://git-scm.com/download/win) in `C:\Program Files\git\bin` directory and run `npm config set script-shell "C:\\Program Files\git\bin\bash.exe"` to change the default shell.
2. [Install Ruby+Devkit](https://rubyinstaller.org/downloads/) - the recommended version is [2.5.5](https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.5-1/rubyinstaller-devkit-2.5.5-1-x86.exe).
A
Anton 已提交
44
3. [Read guide](https://jekyllrb.com/docs/installation/windows/) to get Jekyll up and running without problems.
45

M
Martyna 已提交
46
Once you complete the setup, you'll be able to run the various commands provided from the command line.
A
Anton 已提交
47 48 49 50

## Build locally

1. From the root `/tabler` directory, run `npm run start` in the command line.
Ł
Łukasz Czulak 已提交
51
2. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà.
M
Martyna 已提交
52
3. Any change in the `/pages` directory will build the application and refresh the page.
A
Anton 已提交
53

54
**Note**:
O
onagurna 已提交
55
Run `npm run build` for reforms a one off build application without refresh.
A
Anton 已提交
56
Open [http://localhost:3001](http://localhost:3001) to configure the Web server.
C
chomik 已提交
57

C
chomik 已提交
58
## Feature requests
C
chomik 已提交
59

C
chomik 已提交
60
https://tabler.canny.io/feature-requests
C
chomik 已提交
61 62 63

## Bugs and feature requests

M
Martyna 已提交
64
Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
C
chomik 已提交
65 66 67 68 69 70 71 72 73 74 75

## Creators

**Paweł Kuna**

- <https://twitter.com/codecalm>
- <https://github.com/codecalm>
- <https://codecalm.net>

## Contributors

G
Giovanni Mendoza 已提交
76
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/tabler/tabler/graphs/contributors)].
J
Jun Jiang 已提交
77
<a href="https://github.com/tabler/tabler/graphs/contributors"><img src="https://opencollective.com/tabler/contributors.svg?width=890&button=false"></a>
C
chomik 已提交
78 79 80 81 82 83 84 85 86 87

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tabler#backer)]

<a href="https://opencollective.com/tabler#backers" target="_blank"><img src="https://opencollective.com/tabler/backers.svg?width=890"></a>


## Sponsors

M
Martyna 已提交
88
Support this project by becoming a sponsor. Your logo will be displayed here with a link to your website. [[Become a sponsor](https://opencollective.com/tabler#sponsor)]
C
chomik 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

<a href="https://opencollective.com/tabler/sponsor/0/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/1/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/2/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/3/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/4/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/5/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/6/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/7/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/8/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/9/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/9/avatar.svg"></a>

## 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).