heroweb/templatesrcpoc/README.md

362 lines
18 KiB
Markdown
Raw Normal View History

2024-09-02 06:01:44 +00:00
# [Soft UI Dashboard Pro Tailwind](http://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html?ref=readme-sudpt) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?url=https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind&text=Check%20Soft%20UI%20Dashboard%20Tailwind%20made%20by%20@CreativeTim%20#webdesign%20#dashboard%20#softdesign%20#html%20https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/FhCJCaHdQa)
![version](https://img.shields.io/badge/version-1.1.0-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/soft-ui-dashboard-pro-tailwind.svg)](https://github.com/creativetimofficial/ct-soft-ui-dashboard-pro-tailwind/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/soft-ui-dashboard-pro-tailwind.svg)](https://github.com/creativetimofficial/ct-soft-ui-dashboard-pro-tailwind/issues?q=is%3Aissue+is%3Aclosed)
![Image](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/soft-ui-dashboard/soft-ui-dashboard-pro-tailwind.jpg)
Most complex and innovative Dashboard Made by [Creative Tim](https://creative-tim.com/). Check our latest Premium TailwindCSS Dashboard.
Designed for those who like bold elements and beautiful websites. Made of hundred of elements, designed blocks and fully coded pages, Soft UI Dashboard Pro Tailwind is ready to help you create stunning websites and webapps.
We created many examples for pages like Sign In, Profile and so on. Just choose between a Basic Design, an illustration or a cover and you are good to go!
Crafted with precision using the powerful Jekyll framework, the Soft UI Dashboard Pro Tailwind sets a new standard for web development.
This innovative dashboard seamlessly integrates with Jekyll, allowing for easy integration and customization. The product's modular design offers a range of components and sections that can be effortlessly included in various pages.
This componentized approach not only enhances flexibility but also ensures a streamlined development process. Whether you opt for a section, a component structure, or a page, Soft UI Dashboard Pro Tailwind empowers you to create visually stunning websites and web applications with ease. Elevate your web development experience with this dynamic and feature-rich dashboard.
**Fully Coded Elements**
Soft UI Dashboard Pro Tailwind is built with over 70 frontend individual elements, like buttons, inputs, navbars, navtabs, cards or alerts, giving you the freedom of choosing and combining. All components can take variations in color, that you can easily modify using SASS files and classes.
You will save a lot of time going from prototyping to full-functional code, because all elements are implemented.
This Premium TailwindCSS Dashboard is coming with prebuilt design blocks, so the development process is seamless,
switching from our pages to the real website is very easy to be done.
View [all components here](https://www.creative-tim.com/learning-lab/tailwind/html/alert/soft-ui-dashboard/?ref=readme-sudpt).
**Documentation built by Developers**
Each element is well presented in a very complex documentation.
You can read more about the <a href="https://www.creative-tim.com/learning-lab/tailwind/html/quick-start/soft-ui-dashboard/" target="_blank">documentation here</a>.
**Example Pages**
If you want to get inspiration or just show something directly to your clients,
you can jump start your development with our pre-built example pages. You will be able
to quickly set up the basic structure for your web project.
View <a href="https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html" target="_blank">example pages here</a>.
**HELPFUL LINKS**
- View <a href="https://github.com/creativetimofficial/soft-ui-dashboard-pro-tailwind" target="_blank">Github Repository</a>
- Check <a href="https://www.creative-tim.com/faq" target="_blank">FAQ Page</a>
#### Special thanks
During the development of this dashboard, we have used many existing resources from awesome developers. We want to thank them for providing their tools open source:
- [TailwindCSS](https://tailwindcss.com/)- Open source front end framework
- [Popper.js](https://popper.js.org/) - Kickass library used to manage poppers
- [Flatpickr](https://flatpickr.js.org/) - Useful library used to select date
- [Choices JS](https://joshuajohnson.co.uk/Choices/) - A nice plugin that select elements with intuitive multiselection and searching but also for managing tags.
- [CountUp JS](https://inorganik.github.io/countUp.js/) - A dependency-free, lightweight JavaScript class that can be used to quickly create animations that display numerical data in a more interesting way.
- [Charts Js](https://www.chartjs.org/) - Simple yet flexible JavaScript charting for designers & developers
- [FullCalendar](https://fullcalendar.io/) - Full-sized drag & drop event calendar
- [Dropzone](https://www.dropzonejs.com/) - An open source library that provides dragndrop file uploads with image previews.
- [Datatables](https://github.com/fiduswriter/Simple-DataTables) - DataTables but in Vanilla ES2018 JS
- [jKanban](http://www.riccardotartaglia.it/jkanban/) - Pure agnostic Javascript plugin for Kanban boards
- [PhotoSwipe](https://photoswipe.com/) - JavaScript image gallery for mobile and desktop, modular, framework independent
- [Quill](https://quilljs.com/) - A free, open source WYSIWYG editor built for the modern web
- [Sweet Alerts](https://sweetalert2.github.io/) - A beautiful, responsive, customisable, accessible replacement for Javascripts popup boxes.
- [three.js](https://threejs.org/) - JavaScript 3D library
- [Nepcha Analytics](https://nepcha.com/?ref=readme) for the analytics tool. Nepcha is already integrated with Soft UI Dashboard Pro Tailwind. You can use it to gain insights into your sources of traffic.
Let us know your thoughts below. And good luck with development!
## Table of Contents
- [Soft UI Dashboard Pro Tailwind ](#soft-ui-dashboard-pro-tailwind--)
- [Special thanks](#special-thanks)
- [Table of Contents](#table-of-contents)
- [Versions](#versions)
- [Demo](#demo)
- [Quick start](#quick-start)
- [Terminal Commands](#terminal-commands)
- [Documentation](#documentation)
- [What's included](#whats-included)
- [Browser Support](#browser-support)
- [Resources](#resources)
- [Reporting Issues](#reporting-issues)
- [Technical Support or Questions](#technical-support-or-questions)
- [Licensing](#licensing)
- [Useful Links](#useful-links)
- [Social Media](#social-media)
## Versions
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind?ref=readme-sudpt)
| HTML |
| --- |
| [![Soft UI Dashboard Pro Tailwind HTML](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/soft-ui-dashboard/soft-ui-dashboard-pro-tailwind.jpg)](http://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html?ref=readme-sudpt)
## Demo
- [Dashboard](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html?ref=readme-sudpt)
- [Automotive](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/automotive.html?ref=readme-sudpt)
- [Virtual Reality](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/vr/vr-default.html?ref=readme-sudpt)
- [Profile](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/pages/profile/overview.html?ref=readme-sudpt)
- [Account](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/pages/account/settings.html?ref=readme-sudpt)
- [RTL](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/pages/rtl-page.html?ref=readme-sudpt)
- [Applications](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/applications/kanban.html?ref=readme-sudpt)
- [Ecommerce](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/ecommerce/overview.html?ref=readme-sudpt)
- [Sign In](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/authentication/signin/basic.html?ref=readme-sudpt)
- [Sign Up](https://demos.creative-tim.com/test/soft-ui-dashboard-pro-tailwind/pages/authentication/signup/basic.html?ref=readme-sudpt)
[View More](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html?ref=readme-sudpt).
## Quick start
Quick start options:
- Download from [Creative Tim](https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind?ref=readme-sudpt).
## Terminal Commands
1. Download and Install NodeJs from [NodeJs Official Page](https://nodejs.org/en/download/).
2. Navigate to the root / directory and run npm install to install our local dependencies.
3. Before running the project, make sure you have the following prerequisites installed:
- [Ruby](https://www.ruby-lang.org/en/documentation/installation/): Make sure you have Ruby installed on your machine. You can check if Ruby is installed by running:
```html showLineNumbers
ruby --version
```
- [Jekyll](https://jekyllrb.com/docs/): Jekyll is a static site generator for your project. Install it by running:
```html showLineNumbers
bundle install
```
Learn how to use Softs included npm scripts to start a local server, compile source code, run tests, and more.
<br/>
### How to run the project locally
Our package.json includes convenient methods for working with the framework, including compiling code, running tests, and more.
To use our build system and use Sass to customize your website youll need a copy of Soft UI Dashboard source files and Node. Follow these steps and you should be ready to rock:
• Download and install Node.js, which we use to manage our dependencies. <br/>
• Navigate to the root / directory and run **npm install** to install our local dependencies. <br/>
<br />
##### NPM
Make sure that you have [Node.js](https://nodejs.org/en/) and [Tailwind CSS](https://tailwindcss.com/) installed.
<br/>
When completed, youll be able to run the various commands provided from the command line:
```html showLineNumbers
npm install
```
Run project's live preview:
```html showLineNumbers
npm run dev
```
<br/>
Include the main JavaScript file to make interactive elements working:
```html showLineNumbers
<script src="../path/to/soft-ui-dashboard-tailwind.js"></script>
```
<br />
##### Import Soft UI Dashboard Tailwind Style Sheet
Import the **soft-ui-dashboard-tailwind.css** into your project file. Make sure to import the soft-ui-dashboard-tailwind.css style sheet after all other style sheets.
```html showLineNumbers
<link rel="stylesheet" href="soft-ui-dashboard-tailwind.css" />
```
<br />
## Documentation
The documentation for the Soft UI Dashboard Pro Tailwind is hosted at our [website](https://www.creative-tim.com/learning-lab/tailwind/html/quick-start/soft-ui-dashboard/?ref=readme-sudpt).
### What's included
Within the download you'll find the following directories and files:
```
soft-ui-dashboard-pro-tailwind
.
├── CHANGELOG.md
├── Gemfile
├── Gemfile.lock
├── Gemfile.save
├── README.md
├── _config.yml
├── _data
│   └── sidebarRoutesPro.yml
├── _includes
│   ├── components
│   │   ├── applications/
│   │   ├── authentication/
│   │   ├── dashboards/
│   │   ├── ecommerce/
│   │   ├── navbars/
│   │   ├── pages/
│   │   └── sidenav/
│   ├── fixed-plugin.html
│   ├── footer-auth.html
│   ├── footer.html
│   ├── head.html
│   ├── path/
│   │   └── path-assets.html
│   └── profile-header.html
├── _layouts/
│   ├── authentication.html
│   ├── default.html
│   ├── pricing.html
│   ├── profile.html
│   ├── rtl.html
│   └── vr.html
├── assets/
│   ├── css/
│   ├── fonts/
│   ├── img/
│   └── js/
├── docs/
├── index.html
├── package.json
├── pages
│   ├── applications/
│   ├── authentication
│   │   ├── error
│   │   │   ├── 404.html
│   │   │   └── 500.html
│   │   ├── lock
│   │   │   ├── basic.html
│   │   │   ├── cover.html
│   │   │   └── illustration.html
│   │   ├── reset
│   │   │   ├── basic.html
│   │   │   ├── cover.html
│   │   │   └── illustration.html
│   │   ├── signin
│   │   │   ├── basic.html
│   │   │   ├── cover.html
│   │   │   └── illustration.html
│   │   ├── signup
│   │   │   ├── basic.html
│   │   │   ├── cover.html
│   │   │   └── illustration.html
│   │   └── verification
│   │   ├── basic.html
│   │   ├── cover.html
│   │   └── illustration.html
│   ├── dashboards
│   │   ├── automotive.html
│   │   ├── crm.html
│   │   ├── default.html
│   │   ├── smart-home.html
│   │   └── vr
│   │   ├── vr-default.html
│   │   └── vr-info.html
│   ├── ecommerce
│   │   ├── orders
│   │   │   ├── details.html
│   │   │   └── list.html
│   │   ├── overview.html
│   │   ├── products
│   │   │   ├── edit-product.html
│   │   │   ├── new-product.html
│   │   │   ├── product-page.html
│   │   │   └── products-list.html
│   │   └── referral.html
│   └── pages
│   ├── account
│   │   ├── billing.html
│   │   ├── invoice.html
│   │   ├── security.html
│   │   └── settings.html
│   ├── charts.html
│   ├── messages.html
│   ├── notifications.html
│   ├── pricing-page.html
│   ├── profile
│   │   ├── overview.html
│   │   ├── projects.html
│   │   └── teams.html
│   ├── projects
│   │   ├── general.html
│   │   ├── new-project.html
│   │   └── timeline.html
│   ├── rtl-page.html
│   ├── sweet-alerts.html
│   ├── users
│   │   ├── new-user.html
│   │   └── reports.html
│   └── widgets.html
├── postcss.config.js
├── src
│   └── styles.css
├── tailwind.config.js
└── tailwindcss.rb
```
## Browser Support
At present, we officially aim to support the last two versions of the following browsers:
<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"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
## Resources
- [Live Preview](https://demos.creative-tim.com/soft-ui-dashboard-pro-tailwind/pages/dashboards/default.html?ref=readme-sudpt)
- [Download Page](https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind?ref=readme-sudpt)
- Documentation is [here](https://www.creative-tim.com/learning-lab/tailwind/html/quick-start/soft-ui-dashboard/?ref=readme-sudpt)
- [License Agreement](https://www.creative-tim.com/license?ref=readme-sudpt)
- [Support](https://www.creative-tim.com/contact-us?ref=readme-sudpt)
- Issues: [Github Issues Page](https://github.com/creativetimofficial/soft-ui-dashboard-pro-tailwind/issues)
- [Nepcha Analytics](https://nepcha.com/?ref=readme) - Analytics tool for your website
## Reporting Issues
We use GitHub Issues as the official bug tracker for the Soft UI Dashboard Pro Tailwind. Here are some advices for our users that want to report an issue:
1. Make sure that you are using the latest version of the Soft UI Dashboard Pro. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/product/soft-ui-dashboard-pro-tailwind?ref=readme-sudpt).
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
## Technical Support or Questions
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us?ref=readme-sudpt) instead of opening an issue.
## Licensing
- Copyright 2024 [Creative Tim](https://www.creative-tim.com?ref=readme-sudpt)
- Creative Tim [license](https://www.creative-tim.com/license?ref=readme-sudpt)
## Useful Links
- [More products](https://www.creative-tim.com/templates?ref=readme-sudpt) from Creative Tim
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free?ref=readme-sudpt) from Creative Tim
- [Affiliate Program](https://www.creative-tim.com/affiliates/new?ref=readme-sudpt) (earn money)
##### Social Media
Twitter: <https://twitter.com/CreativeTim>
Facebook: <https://www.facebook.com/CreativeTim>
Dribbble: <https://dribbble.com/creativetim>
Instagram: <https://instagram.com/creativetimofficial>
TikTok: <https://tiktok.com/@creative.tim>