www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/permissions_by_term/js/README.md

   1 # Folder structure
   2
   3 ## NPM
   4 NPM in version 5.6.0 and NodeJS in version 9.11.1 are proven in building the JavaScript code. The build assumes a
   5 *NIX environment (Mac or Linux).
   6
   7 ## babel-compiled
   8 Files which are needed for tests in cli. Because [Babel](https://babeljs.io/) is transpiling the modern ES6 import
   9 statement to CommonJS, which can be parsed by NodeJS.
  10
  11 ## node-modules
  12 Third-party JavaScript libraries.
  13
  14 ## src
  15 The application code.
  16
  17 ## test
  18 Automated tests.
  19
  20 They can be executed via command line ("bat" stands for "build and test"):
  21
  22 `npm run bat`
  23
  24  Or they can be executed via the webbrowser by opening the .html files. Google Chrome
  25  is good for JavaScript debugging. Therefor this option is provided by the QUnit JavaScript
  26  testing tool.
  27
  28 ## Building the application
  29 `npm run build`