apeman-scff-react/README.md

Scaffold for React projects.

apeman-scff-react
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-scff-labo/apeman-scff-react
[bd_travis_url]: http://travis-ci.org/apeman-scff-labo/apeman-scff-react
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-scff-labo/apeman-scff-react.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-scff-labo/apeman-scff-react
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-scff-labo/apeman-scff-react.svg?token=
[bd_license_url]: https://github.com/apeman-scff-labo/apeman-scff-react/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-scff-labo/apeman-scff-react
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-scff-labo/apeman-scff-react.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-scff-labo/apeman-scff-react.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-scff-labo/apeman-scff-react
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-scff-labo/apeman-scff-react.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-scff-react
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-scff-react.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Scaffold for React projects.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
npm install apeman-scff-react --save-dev
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const apemanScff = require('apeman-scff')
const scff = require('apeman-scff-react')

apemanScff(scff, 'project/my-awesome-project', {
  silent: false,
  force: false
}).then(() => {
  /* ... */
})

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Templates.md.hbs" Start -->

<a name="section-doc-guides-03-templates-md"></a>

Template Files
--------------

+ [ci/build.js](asset/tmpl/ci/build.js.tmpl)
+ [ci/capture.js](asset/tmpl/ci/capture.js.tmpl)
+ [ci/deploy.js](asset/tmpl/ci/deploy.js.tmpl)
+ [ci/release.js](asset/tmpl/ci/release.js.tmpl)
+ [ci/share.js](asset/tmpl/ci/share.js.tmpl)
+ [ci/test.js](asset/tmpl/ci/test.js.tmpl)
+ [ci/update.js](asset/tmpl/ci/update.js.tmpl)
+ [ci/watch.js](asset/tmpl/ci/watch.js.tmpl)
+ [doc/demo/demo.component.jsx](asset/tmpl/doc/demo/demo.component.jsx.tmpl)
+ [doc/demo/demo.entrypoint.jsx](asset/tmpl/doc/demo/demo.entrypoint.jsx.tmpl)
+ [doc/guides/01.Installation.md.hbs](asset/tmpl/doc/guides/01.Installation.md.hbs.tmpl)
+ [doc/guides/02.Demo.md.hbs](asset/tmpl/doc/guides/02.Demo.md.hbs.tmpl)
+ [doc/guides/03.Usage.md.hbs](asset/tmpl/doc/guides/03.Usage.md.hbs.tmpl)
+ [doc/guides/04.Components.md.hbs](asset/tmpl/doc/guides/04.Components.md.hbs.tmpl)
+ [doc/images/screenshot.png](asset/tmpl/doc/images/screenshot.png.tmpl)
+ [doc/links.json](asset/tmpl/doc/links.json.tmpl)
+ [doc/overview.md](asset/tmpl/doc/overview.md.tmpl)
+ [example/example-usage.jsx](asset/tmpl/example/example-usage.jsx.tmpl)
+ [lib/~~~~component_name@snakecase~~~~_style.jsx](asset/tmpl/lib/~~~~component_name@snakecase~~~~_style.jsx.tmpl)
+ [lib/~~~~component_name@snakecase~~~~.jsx](asset/tmpl/lib/~~~~component_name@snakecase~~~~.jsx.tmpl)
+ [lib/index.jsx](asset/tmpl/lib/index.jsx.tmpl)
+ [package.json](asset/tmpl/package.json.tmpl)
+ [shim/node/~~~~component_name@snakecase~~~~_style.js](asset/tmpl/shim/node/~~~~component_name@snakecase~~~~_style.js.tmpl)
+ [shim/node/~~~~component_name@snakecase~~~~.js](asset/tmpl/shim/node/~~~~component_name@snakecase~~~~.js.tmpl)
+ [shim/node/index.js](asset/tmpl/shim/node/index.js.tmpl)
+ [test/_setup.js](asset/tmpl/test/_setup.js.tmpl)
+ [test/~~~~component_name@snakecase~~~~_style_test.jsx](asset/tmpl/test/~~~~component_name@snakecase~~~~_style_test.jsx.tmpl)
+ [test/~~~~component_name@snakecase~~~~_test.jsx](asset/tmpl/test/~~~~component_name@snakecase~~~~_test.jsx.tmpl)
+ [test/mocha.opts](asset/tmpl/test/mocha.opts.tmpl)


<!-- Section from "doc/guides/03.Templates.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-scff-labo/apeman-scff-react/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman][apeman_url]
+ [apeman-react-labo][apeman_react_labo_url]
+ [apeman-scaffold][apeman_scaffold_url]
+ [apeman-scff][apeman_scff_url]

[apeman_url]: https://github.com/apeman-labo/apeman
[apeman_react_labo_url]: https://github.com/apeman-react-labo
[apeman_scaffold_url]: https://github.com/apeman-labo/apeman-scaffold
[apeman_scff_url]: https://github.com/apeman-cmd-labo/apeman-scff

<!-- Links End -->