client/README.md
author nowmad@23.1.168.192.in-addr.arpa
Wed, 02 Dec 2015 19:39:35 +0100
changeset 204 3a5c9c460620
parent 195 e0613cc29a30
permissions -rw-r--r--
Added tag V0.1-alpha.6 for changeset 786cdb826f09
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
Ammico client webapp
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
====================
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
195
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     4
This README describes the Ammico client which is a tool to consult and manage museum's visits.
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     5
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     6
Structure:
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     7
---
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     8
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
     9
The application is developed with Angular.
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    10
- app/ : this folder contains the main javascript files of the application
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    11
- img/ : contains the assets needed by the app
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    12
- data/ : (optional) here goes the test file to simulate an interaction with the server if needed
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    13
- build/ : folder created when the app is built by gulp. Contains all the app js, styles and assets.
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    14
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    15
Installation:
0
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
---
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
- `npm install`
195
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    19
- `node_modules/.bin/bower install`
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    20
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    21
Building the app:
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    22
---
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    23
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    24
We use gulp in order to generate the app. To build it you can run the following command line:
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    25
- `./node_modules/.bin/gulp` or simply `gulp` if it is globally installed in your system
0
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
195
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    27
Then to copy the files to the server part you can use:
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    28
- `./node_modules/.bin/gulp copy-server` or simply `gulp copy-server`
0
cef349423167 add basic file org + client prototype
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
195
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    30
Entry points:
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    31
---
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    32
There are few entry points to configure the client. It can be define in the gulpfile or the generated index.html
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    33
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    34
idExpo: 'idExpo: "{{ context.idExpo }}",',
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    35
ammicoUrl: 'ammicoUrl: "{{ context.ammicoUrl }}",',
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    36
searchUrl: 'searchUrl: "{{ context.searchUrl }}",',
e0613cc29a30 update client README
nowmad@23.1.168.192.in-addr.arpa
parents: 0
diff changeset
    37
token: '{% if context.token %} token: "{{ context.token }}", {% endif %}'