Subversion Repositories wimsdev

Rev

Rev 17733 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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