|
1 | | -# DHTMLX JavaScript Kanban Documentation |
| 1 | +<h1 align="center"><a href="https://docs.dhtmlx.com/kanban/">DHTMLX Kanban Documentation</a></h1> |
2 | 2 |
|
3 | | -### Installation |
| 3 | +JavaScript Kanban is an effective solution for the workflow visualization. The widget helps you better understand your business processes and gain an overview of your team workload. This flexible tool allows to work with any number of cards as well as limit number of cards for columns and swimlanes. Fully written in pure JavaScript and CSS, the component can be easily set and customized as well as integrated into any web app or web page. |
| 4 | + |
| 5 | +## Explore documentation locally |
| 6 | + |
| 7 | +To run the Kanban documentation locally, take the following steps: |
| 8 | + |
| 9 | +#### 1. Clone the documentation to the local folder |
| 10 | + |
| 11 | +``` |
| 12 | +$ git clone [email protected]:DHTMLX/docs-kanban.git |
| 13 | +$ cd docs-kanban |
| 14 | +``` |
| 15 | + |
| 16 | +#### 2. Install dependencies |
4 | 17 |
|
5 | 18 | ``` |
6 | 19 | $ yarn |
7 | 20 | ``` |
8 | 21 |
|
9 | | -### Local Development |
| 22 | +#### 3. Run the documentation on the local server and explore it |
10 | 23 |
|
11 | 24 | ``` |
12 | 25 | $ yarn start |
13 | 26 | ``` |
14 | 27 |
|
15 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 28 | +## Related sources |
16 | 29 |
|
17 | | -### Build |
| 30 | +[Download DHTMLX Kanban](https://dhtmlx.com/docs/products/dhtmlxKanban/download.shtml) |
18 | 31 |
|
19 | | -``` |
20 | | -$ yarn build |
21 | | -``` |
| 32 | +[Live demos](https://snippet.dhtmlx.com/5hcx01h4?mode=wide&text=#kanban) |
22 | 33 |
|
23 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 34 | +[Blog](https://dhtmlx.com/blog/tag/kanban/) |
24 | 35 |
|
25 | | -### Deployment |
| 36 | +[Forum](https://forum.dhtmlx.com/c/widgets/kanban) |
26 | 37 |
|
27 | | -``` |
28 | | -$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy |
29 | | -``` |
| 38 | +## Follow us |
| 39 | + |
| 40 | +Star our GitHub repo :star: |
| 41 | + |
| 42 | +Watch our tutorials on [YouTube](https://www.youtube.com/user/dhtmlx/videos) :eyes: |
| 43 | + |
| 44 | +Read us on [Medium](https://medium.com/@dhtmlx) :newspaper: |
| 45 | + |
| 46 | +Follow us on [Twitter](https://twitter.com/dhtmlx) :feet: |
| 47 | + |
| 48 | +Like our page on [Facebook](https://www.facebook.com/dhtmlx/) :thumbsup: |
30 | 49 |
|
31 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 50 | +See our news on [Linkedin](https://www.linkedin.com/groups/3345009/) :mega: |
0 commit comments