Web-Lib-POIClasses

A Collection of javascript classes that are used by applications that deal with out points of interest system

Vue.js Component Library

Introduction

This library aims to encapsulate PrimeWeb's Poi Objects.

Usage

! Please ensure you are logged into npm using a Primayer npm account to access our private repository !

To install the library, from your project root folder in a Terminal, Console, PowerShell or CMD:

npm install --save @primayer/poi-classes

To set the library up, in your main.js file: import PoiClasses from '@primayer/poi-classes'; Vue.use(PoiClasses)

Here is a simple example of how to use the component:

TODO: write this section

Library contents

Here is a list of available JS classes provided by this library:

• TODO: Add documentation here

Contribute

As a fellow member of Primayer's development team, contribution to this library is welcomed and encouraged.

TODO: write this section

Build Process

In order to build the library for testing or distribution:

in a terminal type:

npm run build

Publish

when logged into npm on your local terminal as a Primayer's npm account holder just run npm publish. Please ensure you update the version number in the package.json and create a release tag on GitHub.

Issues, Suggestions and Non-Technical contributions

Any Issues or suggestions should be marked in the repository issue tracker with the appropriate tags and all necessity details.

Any non-technical contributions will be handled on an ad-hoc bases. Usage Documentation/Media will be stored in the manner preferred by Primayer Ltd. as appropriate.

Licencing

No contributions, that are external from Primayer Ltd are allowed, unless express permission is provided by Primayer Ltd.'s management team.

The code and work in this repository (excluding 3rd party open source code) is proprietary and is owned by Primayer Ltd. The files stored in this repository are not for use, redistribution, sale or any other such activity, in part or as a whole. All rights reserved.