client/README.md
author ymh <ymh.work@gmail.com>
Wed, 08 Jan 2020 17:49:53 +0100
changeset 205 147583c43f0d
parent 195 e0613cc29a30
permissions -rw-r--r--
add poetry on sync

Ammico client webapp
====================

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

Structure:
---

The application is developed with Angular.
- app/ : this folder contains the main javascript files of the application
- img/ : contains the assets needed by the app
- data/ : (optional) here goes the test file to simulate an interaction with the server if needed
- build/ : folder created when the app is built by gulp. Contains all the app js, styles and assets.

Installation:
---

- `npm install`
- `node_modules/.bin/bower install`

Building the app:
---

We use gulp in order to generate the app. To build it you can run the following command line:
- `./node_modules/.bin/gulp` or simply `gulp` if it is globally installed in your system

Then to copy the files to the server part you can use:
- `./node_modules/.bin/gulp copy-server` or simply `gulp copy-server`

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

idExpo: 'idExpo: "{{ context.idExpo }}",',
ammicoUrl: 'ammicoUrl: "{{ context.ammicoUrl }}",',
searchUrl: 'searchUrl: "{{ context.searchUrl }}",',
token: '{% if context.token %} token: "{{ context.token }}", {% endif %}'