https://github.com/YerkoPalma/choo-genesis

:globe_with_meridians: Custom choo template
https://github.com/YerkoPalma/choo-genesis

Last synced: 18 days ago
JSON representation

:globe_with_meridians: Custom choo template

• Host: GitHub
• URL: https://github.com/YerkoPalma/choo-genesis
• Owner: YerkoPalma
• License: mit
• Created: 2016-08-31T14:05:35.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-28T13:36:28.000Z (about 8 years ago)
• Last Synced: 2024-10-14T16:27:38.893Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 21.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# <%= projectName %> [![built with choo v3](https://img.shields.io/badge/built%20with%20choo-v3-ffc3e4.svg?style=flat-square)](https://github.com/yoshuawuyts/choo)

> Offline first choo app for designers and web developers

## Features

- Offline first

    - Use [localforage](https://github.com/localForage/localForage) for local data storage

    - Use [service workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API), through [sw-precache](https://github.com/GoogleChrome/sw-precache), to cache assets

- Super simple! (*)

(*) _Because all the work to make it offline first happen without your intervention, is all automatic thanks to npm build scripts and [choo offline plugin](https://github.com/YerkoPalma/choo-offline)_

## Usage

```bash

# start an http local server with livereload

$ npm run dev

# run tests

$ npm test

# generate production files in a dist/ folder

$ npm run build

```

## Handling offline status

If you need to handle offline mode, there are some tricks that can help you with. There is an [offline plugin](https://github.com/YerkoPalma/choo-offline) that manipulate choo hooks and wrappers for offline support.

One of that hooks is triggered whenever an action takes place, and has the responsability to trigger a backup function if there is no internet connection.

To use this, you have to send a `_backup` string in your `send` data. This string should be the name of the action that you expect to get executed. So, your model and view should look like this:

```javascript

const model = {

  state: {

    username: '',

    pass: ''

  },

  reducers: {

    logIn: (data, state) => data.user

  },

  effects: {

    connect: (data, state, send, done) => {

      send('logIn', { _backup: '_connect' }, done)

    },

    _connect: (data, state, send, done) => {

      send('logIn', {}, done)

    }

  }

}

const view = (state, send) => {

  return html`

     send(

        'update',

        { payload: e.target.value, _backup: '_update' }

      )}>

  `

}

```

## License

MIT © [Yerko Palma](https://github.com/YerkoPalma)