Files
old-csveditor/README.md

33 lines
1.6 KiB
Markdown
Raw Normal View History

2014-10-27 15:50:57 +01:00
## FLUX React JS Boilerplate
2014-08-17 19:38:01 +02:00
2014-10-27 15:28:16 +01:00
Based on the architecture suggestions from Facebook, this boilerplate will help you deal with it. It has included the flux-react extension to React JS, [flux-react](https://github.com/christianalfoni/flux-react).
2014-10-27 15:50:57 +01:00
Read more about FLUX over at [Facebook Flux](http://facebook.github.io/flux/) and I wrote a post about it too: [My experiences building a FLUX application](http://christianalfoni.github.io/javascript/2014/10/27/my-experiences-building-a-flux-application.html) and [React JS and FLUX](http://christianalfoni.github.io/javascript/2014/08/20/react-js-and-flux.html)
2014-08-20 19:50:48 +02:00
### How to use
* Clone the repo
* Run `npm install`
2014-10-27 15:28:16 +01:00
* Open `build/index.html`, run `python -m SimpleHTTPServer` in the `build` folder or set up your own server
2014-08-20 19:50:48 +02:00
### Development
* Run `gulp`
2014-10-27 15:28:16 +01:00
* Any changes to `app` folder will automatically rebuild to `build` folder
2014-08-20 19:50:48 +02:00
### Run all tests with Karma
* Run `npm test`
2014-10-27 15:28:16 +01:00
Karma will launch PhantomJS and run the tests once. If you need to run tests in a normal browser change karma.conf.js to use 'Chrome' as browser. You can also keep running the tests as you write them. Set `autoWatch: true` and `singleRun: false`.
2014-08-20 19:50:48 +02:00
### Minify the code, ready for production
2014-10-27 15:28:16 +01:00
* Run `gulp deploy` to deploy to `dist` folder
2014-08-20 19:50:48 +02:00
### Directory
* **app/**: Where you develop the application
2014-10-27 15:28:16 +01:00
* **build/**: Where your automatically builds to. This is where you launch your app in development
2014-08-20 19:50:48 +02:00
* **dist/**: Where the deployed code exists, ready for production
* **tests/**: Where you put your test files
* **gulpfile**: Gulp configuration
* **karma.conf.js**: Karma configuration
* **test.html**: Open when running specific test files