ednl-liftstatus-web-components/README.md

The EDNL LiftStatus web components

# EDNL LiftStatus Web Components

The EDNL LiftStatus web components for use in web applications.

## Installation

Copy or clone the repo and run `npm install`.

To get live data, you need an access token to put in the `<ls-data>` component inside `index.html`.

### How to get an access token

For the time being, navigate to https://next.liftstatus.nl/ and login. On the left, click on "liften".

In the address bar you can append the url with a lift ID like so: https://next.liftstatus.nl/lifts/31901.

The below Lift ID's are great for testing.

| Lift ID |                      Usefulness                      |
| :-----: | :--------------------------------------------------: |
|  31901  |                Has a lot of movement                 |
|  32386  |                Has a lot of movement                 |
|  32383  |                Has a lot of movement                 |
|  31981  |                Has a lot of movement                 |
|  49234  | Good for testing status messages and has a back door |
|  55040  |           Good for testing status messages           |
|  33137  |           Good for testing status messages           |

Once on the selected elevator page, open the developer tools and navigate to the network tab. From here, filter on WS and select the request to api.liftstatus.nl/socket.io. You can find the token in the headers of this request.

Note: if you do not see a request, you might need to refresh the browser with the network tab open.

### Start developing

Copy the access token and give it as a parameter in the `<ls-data>` component inside of `index.html`.

After that you can run `npm run start` to run the project. It should open to localhost:3000.

## Demo

https://ednl-ls-web-components-demo.web.app/

## UNPKG

https://unpkg.com/browse/ednl-liftstatus-web-components/dist/ednl-liftstatus-web-components/

## Implementation manual (docs)

https://springtree.github.io/ednl-liftstatus-web-components/

To edit it you can run `npm run docs`.

## Naming conventions

The repository is guarded by the SpringTree [check git branch name](https://github.com/springtree/check-git-branch-name) package and Commitlint (using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)).

### Git branch names

In a nutshell, just start feature branches with `feature/`.

### Commit messages

For this use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).

Allowed prefixes:
`build`,
`chore`,
`ci`,
`docs`,
`feat`,
`fix`,
`perf`,
`refactor`,
`revert`,
`style`,
`test`