Subversion Repositories wimsdev

Rev

Rev 16497 | Rev 18248 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
13570 obado 1
We use `Yarn` to automatically download JS packages/plugins,
11388 obado 2
And then we use `Grunt` to perform special tasks (concat, minify, verify ...)
9822 obado 3
 
10445 obado 4
# Installation
5
--------------
9822 obado 6
 
13570 obado 7
## Install Yarn :
8
*  See here : [install Yarn](https://yarnpkg.com)
9
    brew install yarn
9822 obado 10
 
10445 obado 11
## Install Grunt :
16493 obado 12
    yarn upgrade
13
    yarn global add grunt-cli
9886 obado 14
 
15
 
13728 obado 16
# Manage Packages
10445 obado 17
-----------------------
9886 obado 18
 
13728 obado 19
## Audit each dependency if there is a known issue to fix:
13570 obado 20
    yarn audit
9822 obado 21
 
13728 obado 22
## Update Javascripts plugins:
13570 obado 23
    yarn upgrade
9886 obado 24
 
10445 obado 25
# Download new Package(s)
26
-------------------------
13570 obado 27
    yarn add <package>
10445 obado 28
 
17733 obado 29
nb: When upgrading TinyMCE 6, you must also manually download language packs here :
30
https://www.tiny.cloud/get-tiny/language-packages/
31
(i.e for French : https://download.tiny.cloud/tinymce/community/languagepacks/6/fr_FR.zip)
10445 obado 32
 
33
# Migrate files from _packages/ to wims/
34
  #  After each update, Grunt is handy to automatically compress js + css, and move each files at is wims destination. simply call "grunt"
10963 obado 35
 
10445 obado 36
    grunt
15332 obado 37
    yarn run build
10445 obado 38
 
17733 obado 39
# Test & Check
40
After each js package update, look at these URL:
41
* jquery-ui
42
    * Tabs : [searchform](http://localhost/wims/?cmd=new&module=home&search_keywords=oef&search_category=A&search_lang=fr#searchform)
43
    * Menu : [H6/algebra/docnatural.fr](http://localhost/wims/?module=H6/algebra/docnatural.fr)
44
* jsXgraph
45
    * [U1/geometry/oeftiling.fr](http://localhost/wims/?module=U1/geometry/oeftiling.fr&cmd=new&exo=translation)
46
* CodeMirror 5
47
    * slib/coding/editor : [H4/programming/pixelart.fr](http://localhost/wims/wims.html?&cmd=new&module=H4/programming/pixelart.fr)
48
* jQuery
49
    * needed at least by Jquery UI
50
* jQuery-hoverintent
51
    * ??
52
* jQuery-ui-Slider-Pips
53
    * Level filter in "Searching for a teaching material" on WIMS home http://localhost/wims/
54
* slick-carousel
55
    * "Samples" on WIMS home http://localhost/wims/
56
* Marked
57
    * http://localhost/wims/wims.html?module=help%2Fwimsdoc.en&+cmd=new&+style=integral#anstype_content
58
* chart.js
59
    * http://localhost/wims/wims.html?cmd=new&module=adm%2Fstat%2Fstat&special_parm=module_updates 
60
 
61
 
62
 
16497 obado 63
# Cleaning
64
----------
65
    yarn cache clean
66
    yarn autoclean --force
67
 
68
 
10445 obado 69
#  Documentations
10963 obado 70
-----------------
13570 obado 71
* [Yarn docs](https://yarnpkg.com/docs)
10445 obado 72
* [Grunt HowTo (video fr)](http://www.grafikart.fr/tutoriels/grunt/grunt-introduction-470)
73
* [Grunt "getting started"](http://gruntjs.com/getting-started)