https://github.com/xvezda/hotcake

:pancakes: Bring simple auto refresh (or live reload) to your web project right away
https://github.com/xvezda/hotcake

auto-refresh javascript live-reload web-development-utility

Last synced: about 2 months ago
JSON representation

:pancakes: Bring simple auto refresh (or live reload) to your web project right away

• Host: GitHub
• URL: https://github.com/xvezda/hotcake
• Owner: Xvezda
• License: mit
• Created: 2020-08-14T16:51:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-03T15:49:24.000Z (over 4 years ago)
• Last Synced: 2025-02-26T15:40:09.951Z (2 months ago)
• Topics: auto-refresh, javascript, live-reload, web-development-utility
• Language: JavaScript
• Homepage: https://npm.im/hotcake
• Size: 6.23 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hotcake

[![Version](https://img.shields.io/npm/v/hotcake)](https://npm.im/hotcake)

[![License](https://img.shields.io/npm/l/hotcake)](https://npm.im/hotcake)

[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/standard/semistandard)

Bring HMR-like auto refresh functionality without any server (e.g. `websocket`, `socket.io`, etc.) and keep it minimal, simple.

![Demo](https://gist.githubusercontent.com/Xvezda/926edfc7b961c31a17751a8c9f4351b6/raw/hotcake.gif)

## Installation

Add following tag to your html file.

```html

```

Or Via GitHub. (Not recommended)

```html

```

Or even with npm... (Also not recommended)

```sh

npm install --save-dev hotcake

```

## Usage

After installation, you can explicitly initialize hotcake with options.

```html

new Hotcake({

    observe: ['./', './app.js'],

    interval: 5000

});

```

If hotcake not initialized explicitly, it will automatically initialize with default options when window loaded.

## Options

| name     | type       | description                                     | default  |

| -------- | ---------- | ----------------------------------------------- | -------  |

| observe  | `string[]` | Path of files to observe.                       | `['./']` |

| interval | `number`   | Millisecond value of interval between requests. | `3000`   |

## License

Copyright (C) 2020 Xvezda

[MIT License](LICENSE)