Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeybaker/flux-play
Just playing around with react, flux, es6, react-router and such
https://github.com/joeybaker/flux-play
Last synced: 6 days ago
JSON representation
Just playing around with react, flux, es6, react-router and such
- Host: GitHub
- URL: https://github.com/joeybaker/flux-play
- Owner: joeybaker
- License: other
- Created: 2015-04-29T00:36:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-05-01T23:15:24.000Z (over 9 years ago)
- Last Synced: 2024-11-27T11:13:01.912Z (about 2 months ago)
- Language: JavaScript
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# flux-play
Uses [immutable.js](https://facebook.github.io/immutable-js/docs/) with [immstruct](https://github.com/omniscientjs/immstruct/) for data.
[flummox](https://acdlite.github.io/flummox) is the flux implementation.
And of course, [react-router](https://github.com/rackt/react-router).
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*
- [Install](#install)
- [Usage](#usage)
- [Developing](#developing)
- [Requirements](#requirements)
## Install
```sh
git clone https://github.com/joeybaker/flux-play
cd flux-play
npm i
```
## Usage
Use ribcage-preview to demo these. There are also handy npm scripts
```sh
# run the big demo
npm run demos
# run the in-progress project
npm run erbody
```
## Tests
Tests are in [tape](https://github.com/substack/tape) and code coverage is run though [covert](https://github.com/substack/covert).
* `npm test` will run both server and browser tests
* `npm run test-browser` run their respective tests
* `npm run tdd-browser` will run the server tests on every file change.
## Developing
_NOTE: you might need to `sudo ln -s /usr/local/bin/node /usr/bin/node` to ensure node is in your path for the git hooks to work_
### Requirements
* **npm > 2.0.0** So that passing args to a npm script will work. `npm i -g npm`
* **git > 1.8.3** So that `git push --follow-tags` will work. `brew install git`
## License
Artistic 2.0 © []()
[npm-url]: https://npmjs.org/package/flux-play
[npm-image]: https://badge.fury.io/js/flux-play.svg
[travis-url]: https://travis-ci.org//flux-play
[travis-image]: https://travis-ci.org//flux-play.svg?branch=master
[daviddm-url]: https://david-dm.org//flux-play.svg?theme=shields.io
[daviddm-image]: https://david-dm.org//flux-play