https://github.com/ElemeFE/bowl

🍚 static resources front-end storage solving strategy
https://github.com/ElemeFE/bowl

Last synced: about 1 year ago
JSON representation

🍚 static resources front-end storage solving strategy

• Host: GitHub
• URL: https://github.com/ElemeFE/bowl
• Owner: ElemeFE
• License: mit
• Created: 2016-11-05T00:17:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-28T06:38:15.000Z (about 9 years ago)
• Last Synced: 2024-10-13T01:48:14.649Z (almost 2 years ago)
• Language: JavaScript
• Homepage: https://elemefe.github.io/bowl/
• Size: 603 KB
• Stars: 225
• Watchers: 16
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# bowl.js

[![npm](https://img.shields.io/npm/v/bowl.js.svg?style=flat-square)](https://www.npmjs.com/package/bowl.js)

[![npm](https://img.shields.io/npm/dt/bowl.js.svg?style=flat-square)](https://www.npmjs.com/package/bowl.js)

[![license](https://img.shields.io/github/license/elemefe/bowl.svg?style=flat-square)](https://github.com/ElemeFE/bowl)

[![GitHub stars](https://img.shields.io/github/stars/elemefe/bowl.svg?style=social&label=Star)](https://github.com/ElemeFE/bowl)

> 🍚 static resources front-end storage solving strategy

## Links

+ [Documentation](https://elemefe.github.io/bowl/)

## Screenshot

![](https://raw.githubusercontent.com/classicemi/bowl/develop/assets/demo.gif)

## Quick Start

For those resources that need to be cached, you do not have to insert `script` tags to the pages. Just write a little piece of JavaScript and **bowl** will take care of it.

```html

var bowl = new Bowl()

bowl.add([

  { url: 'dist/vendor.[hash].js', key: 'vendor' },

  { url: 'dist/app.[hash].js', key: 'app' },

  { url: 'dist/style.[hash].css', key: 'style' }

])

bowl.inject().then(() => {

  // do some stuff

})

```

**bowl** will add these resources to cache(currently localStorage). whenever the url of the resources get modified, bowl will update the files in the cache. For more useful functions of **bowl**, just checkout the [API document](https://elemefe.github.io/bowl/).

## Development Setup

After cloning the repo, run:

```shell

$ yarn install # yep, yarn is recommended. :)

```

### Commonly used NPM scripts:

```shell

# watch and auto rebuild lib/bowl.js and lib/bowl.min.js

$ npm run dev

# watch and auto re-run unit tests in Chrome

$ npm run test:unit

# build all dist files

$ npm run build

```

## License

MIT