Documentation
Introduction
We’ve created this admin panel for everyone who wants to create any templates 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!
Setup environment
To use our build system and run our documentation locally, you’ll need a copy of Tabler’s source files. Follow these steps:
- Install Node.js, which we use to manage our dependencies.
- Navigate to the root
/tabler
directory and runnpm install
to install our local dependencies listed inpackage.json
. - Install Ruby, recommended version is 2.5.5.
- Install Bundler with
gem install bundler
, and finally runbundle install
. This will install all Ruby dependencies, such as Jekyll and plugins.
Windows users:
- Install Git in
C:\\Program Files\\git\\bin
directory and runnpm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
to change default shell. - Install Ruby+Devkit, recommended version is 2.5.5.
- Read guide to get Jekyll up and running without problems.
When completed, you’ll be able to run the various commands provided from the command line.
Build Tabler locally
- From the root
/tabler
directory, runnpm run start
in the command line. - Open http://localhost:4000 in your browser, and voilà.
- Any change in
/pages
directory will build application and refresh the page.
Note:
Run npm run build
for rerforms a one off build application without refresh.
Open http://localhost:3001 to configure the Web server.
Bugs and feature requests
Have a bug or a feature request? Please open a new issue.