Trace-Based Systems - Silex Team

User Tools

Site Tools

Trace:
tools:taaabs:doc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
tools:taaabs:doc [2015/09/04 17:49]
rcazenav 		tools:taaabs:doc [2018/12/10 13:20] (current)
pchampin Marked as deprecated.
Line 1: Line 1:
 +This page is **deprecated**. Wee keep it only for archival purposes.
 +
 +Please visit the [[https://taaabselements.github.io/|newer documentation]].
 +
 ====== Taaabs Documentation ====== ====== Taaabs Documentation ======
 ===== Common Prerequisites ===== ===== Common Prerequisites =====
Line 17: Line 21:
 We use ''npm'' for installing build tools and build dependencies. We use ''npm'' for installing build tools and build dependencies.
  
-===== Gulp =====+===== Clone the project ===== 
 +''git clone git@github.com:liris-tweak/taaabs.git''
  
 +''cd taaabs/''
 +
 +===== Gulp =====
 Then, you need to install gulp, as an executable application.  Then, you need to install gulp, as an executable application. 
 ''[sudo] npm install -g gulp'' will install ''gulp'' for you in ''/usr/lib/node_modules/'' and the executable will be available as a link on ''/usr/bin''. ''[sudo] npm install -g gulp'' will install ''gulp'' for you in ''/usr/lib/node_modules/'' and the executable will be available as a link on ''/usr/bin''.
Line 31: Line 39:
  
 ===== Bower ===== ===== Bower =====
- 
 Then, you can install ''bower'', as an executable application. ''[sudo] npm install -g bower'' will install ''bower'' for you in the same way as explained before. Then, you can install ''bower'', as an executable application. ''[sudo] npm install -g bower'' will install ''bower'' for you in the same way as explained before.
  
 Now you can try the command ''bower'' in your terminal. If ''bower'' is installed correctly you can see a short manual about how to use ''bower''. A thorough reading of this message is not necessary, but might be entertaining. Now you can try the command ''bower'' in your terminal. If ''bower'' is installed correctly you can see a short manual about how to use ''bower''. A thorough reading of this message is not necessary, but might be entertaining.
  
-===== Installing developers dependencies =====+===== Installing build dependencies ===== 
 +Then, you must fetch the build dependencies of the project: ''npm install -d''. When you run this command, ''npm'' read the ''package.json'' file which contains developers dependencies. By default, theses dependencies are stored in the ''node_modules/'' directory at the root of the project. The ''-d'' option in ''npm'' means that you want to install the dependencies declared as ''"devDependencies"'' in the ''package.json'' file. 
 + 
 +===== Installing client-side dependencies ===== 
 +Then, you must fetch the client-side dependencies of the project: ''bower install''. ''bower'' will read the ''bower.json'' and by default theses dependencies are stored in the ''bower_components/'' directory at the root of the project.  
 + 
 +====== Development Worflow ====== 
 + 
 +===== JSHint ===== 
 +We use [[http://jshint.com/docs/|JSHint]] to check suspicious usage in the JavaScript code inside Taaabs. This application take JavaScript code, parse it, and do some syntaxic/semantic checking.  
 + 
 +When building ''Taaabs'' (using ''gulp'' command), JSHint run a check on all files inside app/ directory.  
 +<note warning>If you ignore these warnings, the building process cannot complete.</note> 
 + 
 +We suggest you to  
 +I suggest that you regularly scan your code using 
 + 
 + 
 +===== JSCS ===== 
 + 
 +===== Project Directory Structure ===== 
 +''app/'': Directory containing sources of the application. 
 + 
 +''bower.json'': A file describing client-side dependencies of the project. 
 + 
 +''bower_components/'': Directory containing client-side dependencies. 
 + 
 +''dist/'': Contains the "production" files (this directory can be served by an HTTP server like Apache, Nginx) 
 + 
 +''gulpfile.js'': File describing the build process. 
 + 
 +''node_modules/'': Directory containing build dependencies (or server-side dependencies for Node.js based server applications).  
 + 
 +''package.json'': A file describing build dependencies of the project. (usually this folder contains server-side dependencies for Node.js based server applications) 
 + 
 +''.bowerrc'': Configuration file for ''bower'' 
 + 
 +''.jscsrc'': configuration file for JSCS (JSCS is a code style linter for programmatically enforcing your style guide).  
 + 
 +''.jshintrc'': configuration file for JSHint (JSHint is a tools to detect suspicious usage in programs written in JavaScript). 
 + 
 +''wct.conf.json'': A file desbribing Unit tests 
 + 
 +===== Running the development web server ===== 
 + 
 +When you are modifing sources files of ''Taaabs'', you can see a continuous updated version on your browser. 
 +To do this, use ''gulp serve'', and open http://localhost:3000/ in Chromium browser or Chrome browser. 
  
-Then, you must fetch the developers dependencies of the project: ''npm install -d''. When you run this command, ''npm'' read the ''package.json'' file which contains developers dependencies. By default, theses dependencies are stored in the ''node_modules/'' directory at the root of the project.+===== Run the simple webserver ===== 
 +''gulp simpleserver''
  
 +Then open http://localhost:8080/dist/ .
  
tools/taaabs/doc.1441381753.txt.gz · Last modified: 2015/09/04 17:49 by rcazenav

Page Tools

CNRS INSA de Lyon Université Lyon 1 Université Lyon 2 École centrale de Lyon