summaryrefslogtreecommitdiff
path: root/doc/assets.markdown
blob: 04082c9e3291fe35c8154c5b1aaabd841c8a47d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
How to build assets (Javascript and CSS files)
==============================================

Stylesheet and Javascript files are merged together and minified.

- Original CSS files are stored in the folder `assets/css/src/*.css`
- Original Javascript code is stored in the folder `assets/js/src/*.js`
- `assets/*/vendor.min.*` are external dependencies merged and minified
- `assets/*/app.min.*` are application source code merged and minified

Requirements
------------

- [NodeJS](https://nodejs.org/) with `npm`

Building Javascript and CSS files
---------------------------------

Kanboard use [Gulp](http://gulpjs.com/) to build the assets and [Bower](http://bower.io/) to manage dependencies.
These tools are installed as NodeJS dependencies into the project.

### Run everything

```bash
make static
```

### Build `vendor.min.js` and `vendor.min.css`

```bash
gulp vendor
```

### Build `app.min.js`

```bash
gulp js
```

### Build `app.min.css`

```bash
gulp css
```

Notes
-----

Building assets is not possible from the Kanboard's archive, you have to clone the repository.