4 Dev:

     4 This README describes the Ammico client which is a tool to consult and manage museum's visits.

     5 

     6 Structure:

     7 ---

     8 

     9 The application is developed with Angular.

    10 - app/ : this folder contains the main javascript files of the application

    11 - img/ : contains the assets needed by the app

    12 - data/ : (optional) here goes the test file to simulate an interaction with the server if needed

    13 - build/ : folder created when the app is built by gulp. Contains all the app js, styles and assets.

    14 

    15 Installation:

     8 - `node_modules/.bin/gulp`

    19 - `node_modules/.bin/bower install`

     9 - `node_modules/.bin/bower install -D <some-packages>`

    11 TODO:

    21 Building the app:

    12 -----

    22 ---

    14 - unit tests

    24 We use gulp in order to generate the app. To build it you can run the following command line:

    25 - `./node_modules/.bin/gulp` or simply `gulp` if it is globally installed in your system

    26 

    27 Then to copy the files to the server part you can use:

    28 - `./node_modules/.bin/gulp copy-server` or simply `gulp copy-server`

    29 

    30 Entry points:

    31 ---

    32 There are few entry points to configure the client. It can be define in the gulpfile or the generated index.html

    33 

    34 idExpo: 'idExpo: "{{ context.idExpo }}",',

    35 ammicoUrl: 'ammicoUrl: "{{ context.ammicoUrl }}",',

    36 searchUrl: 'searchUrl: "{{ context.searchUrl }}",',

    37 token: '{% if context.token %} token: "{{ context.token }}", {% endif %}'