README
Worlds App
Why
Worlds app is a librery oriented to show a catalog of products in the shape of a carousel
Commands
make init
: It will download the project's dependencies and configure git hooks.npm run start
: It will start a server onhttp://localhost:9000
with the code.npm run dev
: It will start compiling the code on dev mode and it will be looking for new changes.npm run lint
: It will run the lint rules on the project.npm run test
: It will run the unit tests + it's going to show the current code coverage of the project.make build
: It will create the build meant for production ready lib.
How use
To use this project, the following are required:
DEV
:
<!-- ... -->
<head>
<!-- ... -->
<script>
var configuration = {...}
</script>
<script src="path/of/statics/js/app.js" defer></script>
</head>
<body>
<!-- ... -->
<section id="app"></section>
<!-- ... -->
</body>
<!-- ... -->
PROD
:
<Worlds configuration={configuration} />;
The configuration should be as follows:
- id
<string>
: id of configuration. default''
- name
<string>
: name of configuration. default''
- zoneKey
<string>
: zoneKey of configuration. default''
- cartridgeId
<string>
: identifier for endeca. default''
- dynamicData
<object>
: data configured in endeca- endPoint
<string>
: endpoint for get information of world by id. - worlds
<arrayOf(<object>)>
: array of world object.- id
<string>
: id of world - name
<string>
: name of world - activeIconUrl
<string>
: url of active icon - passiveIconUrl
<string>
: url of deactive icon - mDetailDebugInfo
<bool>
: debugger mod. defaultfalse
- mComponentFieldDataConfigDomId
<string>
: - mTrackDTODetail
<bool>
: track dto detail. defaulttrue
- id
- endPoint
- rawZoneKey
<string>
: name of the zone - type
<string>
: type of component. dafaulthtml
- key
<string>
: key for find in endeca