https://github.com/stadgent/npm_package_opening-hours-widget
NPM package for openinghours API
https://github.com/stadgent/npm_package_opening-hours-widget
d09check22 javascript web
Last synced: about 1 year ago
JSON representation
NPM package for openinghours API
- Host: GitHub
- URL: https://github.com/stadgent/npm_package_opening-hours-widget
- Owner: StadGent
- Created: 2018-11-27T07:12:38.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-20T14:57:03.000Z (almost 3 years ago)
- Last Synced: 2025-04-18T22:51:22.979Z (about 1 year ago)
- Topics: d09check22, javascript, web
- Language: HTML
- Homepage:
- Size: 384 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# Opening Hours Widget
This library serves as a wrapper for the
[openingsuren.gent.be](https://openingsuren.gent.be) API.
## Installation
Install the dependencies:
```bash
npm install @digipolis-gent/opening-hours-widget
```
## Usage
### CommonJS
```javascript
const OpeningHoursWidget = require('@digipolis-gent/opening-hours-widget').default;
let ohw = new OpeningHoursWidget(options);
```
### ES Imports
```javascript
import OpeningHoursWidget from '@digipolis-gent/opening-hours-widget';
let ohw = new OpeningHoursWidget(options);
```
### Browser
**HTML**:
```html
```
**JS**:
```js
let ohw = new OpeningHoursWidget(options);
```
## Development
### Setup
If you'd like to make adjustments to the source code, you can set up this
project locally.
To clone the repo and install dependencies:
```bash
$ git clone git@github.com:StadGent/npm_package_opening-hours-widget.git
$ cd npm_package_opening-hours-widget
$ npm install
```
### Watch
This will run tests on files every time a change is saved.
```shell
$ npm start
```
### Test
We use [Jest](https://jestjs.io/) for testing.
```shell
$ npm test
```
will run all tests.
## Built With
- [EcmaScript 2017](https://www.ecma-international.org/ecma-262/8.0/index.html)
: The programming language used
- [Babel](https://babeljs.io/) : JavaScript Transpiler
- [NPM](https://www.npmjs.com/) : Dependency Management
## Contributing
Thanks for your interest in contributing! [Get started here](.github/CONTRIBUTING.md).
## Authors
- Helena Standaert - *Initial work* - [GitHub](https://github.com/hstandaert)
- Bart Delrue - *Contribution* - [GitHub](https://github.com/delrueba)