Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timekit-io/booking-js
:date: Make a beautiful embeddable booking widget in minutes
https://github.com/timekit-io/booking-js
Last synced: 1 day ago
JSON representation
:date: Make a beautiful embeddable booking widget in minutes
- Host: GitHub
- URL: https://github.com/timekit-io/booking-js
- Owner: timekit-io
- License: mit
- Created: 2015-10-22T12:50:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T15:26:25.000Z (about 1 year ago)
- Last Synced: 2025-02-06T12:07:37.925Z (9 days ago)
- Language: JavaScript
- Homepage: https://developers.timekit.io/docs/booking-widget-v2
- Size: 18.4 MB
- Stars: 2,424
- Watchers: 59
- Forks: 188
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-github-repos - timekit-io/booking-js - :date: Make a beautiful embeddable booking widget in minutes (JavaScript)
README
# Booking.js by Timekit
> Make a beautiful embeddable booking widget in minutes running on the Timekit API.
⚠️ This is **version 3** of booking.js that supports the new projects model and uses App Widget Key for authentication.
- Version 1/2 will not be supported anymore
## Documentation
All documentation, guides and examples can be found on [our developer portal](https://developers.timekit.io/v2/docs/booking-widget-v2).
*This repo is mainly for community contributions, and the curious soul that would like to customize the widget.*
## Roadmap/todos
See [Issues](https://github.com/timekit-io/booking-js/issues) for feature requests, bugs etc.
## License attributions
The `json-schema` v0.2.3 package is used pursuant to the BSD-3-Clause license
### Setting up locally
Checkout this new project locally using git command showed below:
```
# go to timekit workspace
cd ~/timekit-io
# clone this new project loacally
git clone [email protected]:timekit-io/bookingjs.git
# install depedencies
yarn install
# run bookingjs project
# for local testing use: http://localhost:8081
yarn dev
```
## How to publish changes to npm
make sure you upgrade version number in package.json file follow sementic versioning
- run ```yarn test``
- test manually to make sure widget works fine
- merge your changes to master and pull master branch locally
- make sure your changes are uptodate and clean
- run following commands
```
# login as tulipnpm user
yarn login
# commit and publish new changes
yarn publish
```