Home Explore Help
Sign In
SMusatov
/
tabler
mirror of https://github.com/tabler/tabler.git
1
0
Fork 0
Files
Branch: main
Branches Tags
tabler
/
docs
/
getting-started
/
index.mdx

index.mdx 2.7 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940 
  1. ---
    2. 

  2. title: Introduction
    3. 

  3. description: Free and open-source HTML Dashboard UI Kit built on Bootstrap
    4. 

  4. ---
    5. 

  5. 

  6. ## What is Tabler?
    7. 

  7. 

  8. Tabler is fully responsive and compatible with all modern browsers. Thanks to its modern and user-friendly design you can create a fully functional interface that users will love! Choose the layouts and components you need and customize them to make your design consistent and eye-catching. Every component has been created with attention to detail to make your interface beautiful!
    9. 

  9. 

  10. ## What are the benefits?
    11. 

  11. 

  12. Tabler is a perfect solution if you want to create an interface which is not only user-friendly but also fully responsive. Thanks to the big choice of ready-made components, you can customize your design and adapt it to the needs of even the most demanding users. On top of that, Tabler is an open source solution, continuously developed and improved by the open source community.
    13. 

  13. 

  14. ![](https://raw.githubusercontent.com/tabler/tabler/dev/src/static/tabler-preview.png)
    15. 

  15. 

  16. ## Set up the environment
    17. 

  17. 

  18. To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below:
    19. 

  19. 

  20. 1. [Install Node.js](https://nodejs.org/download/), which we use to manage our dependencies.
    21. 

  21. 2. Navigate to the root `/tabler` directory and run `npm install` to install our local dependencies listed in `package.json`.
    22. 

  22. 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).
    23. 

  23. 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).
    24. 

  24. 

  25. ### Windows users
    26. 

  26. 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.
    27. 

  27. 2. [Install Ruby+Devkit](https://rubyinstaller.org/downloads/) - 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).
    28. 

  28. 3. [Read guide](https://jekyllrb.com/docs/installation/windows/) to get Jekyll up and running without problems.
    29. 

  29. 

  30. Once you've completed the setup, you'll be able to run the various commands provided from the command line.
    31. 

  31. 

  32. ## Build Tabler locally
    33. 

  33. 

  34. 1. From the root `/tabler` directory, run `npm run start` in the command line.
    35. 

  35. 2. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà.
    36. 

  36. 3. Any change in `/src` directory will build the application and refresh the page.
    37. 

  37. 

  38. ## Bugs and feature requests
    39. 

  39. 

  40. Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
    41.