summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-05-15 12:33:44 -0400
committerFrederic Guillot <fred@kanboard.net>2016-05-15 12:33:44 -0400
commitc15c4ba0f40926a3320ddf4567692f339b7e45ef (patch)
tree40a688fd3c1c16901a070a1540c1377ad6d3c46c /doc
parent68c087e85cb1678172478d67d106c239ccb2d878 (diff)
Use latest hipster tools to manage assets
Diffstat (limited to 'doc')
-rw-r--r--doc/assets.markdown44
1 files changed, 34 insertions, 10 deletions
diff --git a/doc/assets.markdown b/doc/assets.markdown
index 29bf515b..04082c9e 100644
--- a/doc/assets.markdown
+++ b/doc/assets.markdown
@@ -5,21 +5,45 @@ 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
------------
-- Unix operating system
-- make
-- yuicompressor in your path (`brew install yuicompressor`)
+- [NodeJS](https://nodejs.org/) with `npm`
-Build assets
-------------
+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`
-- Build Stylesheet files: `make css`
-- Build Javascript files: `make js`
-- Build both: `make`
+```bash
+gulp css
+```
-This script generates the files `assets/css/app.css` and `assets/js/app.js`.
+Notes
+-----
-This tool is only available in the repository (development version).
+Building assets is not possible from the Kanboard's archive, you have to clone the repository.