/react-boilerplate

Switch branches/tags
Nothing to show
Find file History
react-boilerplate/docs/
Latest commit c28e153 Sep 22, 2017 @justingreenberg justingreenberg Merge v3.5 release (#1929) 
* Docs Update: sass.md | New webpack version -loader suffix (#1484)

* New webpack version -loader suffix

New webpack version no longer allowed to omit the '-loader' suffix when using loaders.

* Webpack 2 migration module.loaders => module.rules

* Fix Loaders/Rules

* chore(docs): fix link to redux-saga docs

Fix a broken link to redux-saga docs.

* feat(webpack): Support OpenType fonts with .otf file extension (#1471)

* chore(docs): improve testing documentation

* [doc] improve code snippet syntax in unit-testing doc

linted code snippet and removed uneeded import

* [doc] add overview of reducer test in unit testing doc

add the completed reducer test file as overview in unit testing documentation

* [doc] improve component testing doc

linted code snippets, added complete test file as refernce and link to next doc page.

* chore(setup): remove LGTM config files (#1317)

* chore(setup): remove LGTM

* Add collaborating guidelines

* Add @KarandikarMihir

* Remove .react.js extensions (#1469)

* Remove .react.js extensions

* Restore file names in the title comments

* Remove hyphens

* chore(deps): update deps roll-up Jan-21-2017 (#1501)

* fix(tests): Replace sinon restore (#1512)

* Remove sinon.restore()

* Lock down sinon version

* chore(all): move to an organisation on GitHub

* Make webpack build less verbose (#1510)

* removed route names from app/routes (#1509)

* removed route names from app/routes

* removed name prop from internals/templates/routes

* removed name from internals/gens/route/route.hbs and routeWithReducer.hbs

* fix(eslint): Enable rule react/no-array-index-key (#1521)

* enable rule react/no-array-index-key

* fix test of List component

* fix(dependencies.js): clean up console clutter for install scripts (#1532)

Ref #1506

* Fix typo i18n.md (#1541)

* chore(deps): update deps roll-up Jan-28-2017 (#1531)

* chore(deps): update deps roll-up Jan-28-2017

* Update package.json

* Set history@3.2.1

* Using optimised version of the banner (#1560)

Taken from #907

* test(build:clean script): remove test:clean from build:clean - fixes coveralls reporting? (#1563)

* Update docs (README.md, Gotchas.md) (#1534)

* Update README.md

* Update gotchas.md

* Add links to gotchas

* Update docs

* Remove redundant sentence

* Move reinstall steps to gotchas.md

* Update README.md

* Minor corrections

* Add jest cache clean to gotchas.md

* Fix team of devs link (#1566)

* chore(deps): update deps roll-up Feb-04-2017 (#1561)

* Add iOS home screen icon (#1585)

* fix manifest icons (#1568)

* manifest(fix) (#1594)

* Change dev source map style (#1559)

* (fix) ProgressBar state error (#1553)

* Bind listener to the current instance of component

* Bring up coverage

* Reassign listener with newly bound listener

* Minor changes

* Separated dev and prod middlewares (#1556)

* Update FAQ with Styles getting overridden (#1592)

* Improve <List> tests (#1134)

* Fix imported styles (#1599)

* Migrate webpack loaders

* Add comment to CSS loader
This should help clarify and reduce common problems

* Split css rules into two

* Updated docs

* First draft of new styling docs

* Fix Sass heading

* Fix links and wording

* Add LESS and other improvements

* Post test fixes

* Updated headings and added more info section

* fix: Intl polyfill for language generator (#1611)

* fix: Intl polyfill for language generator
* fix: appveyor chrome issue by adding suggested --ignore-checksums

* Fix broken link in documentation. Fixes #1638. (#1643)

* refactor(react-router-scroll): Import only useScroll (#1609)

* chore(package.json): sort ESLint config (#1660)

This PR will sort the ESLint configuration alphabetically in `package.json`.

* Fix iOS home screen icons (#1604)



* Use absolute paths

* AppVeyor install chrome ignoring checksums

* Add Stateless Functions to Container Generator (#1494)

* Add Stateless Functions to Container Generator

* Fix linting test for generators

* Tightened up generator type names

- Also made component and container use similar order and language

* Fix odd node5 issue

* and disable eslint for the var

* Fix missing reference (#1725)

* Moving Contrib documentation to the right place (#1721)

* refactor(react-router): Import only necessary components (#1608)

Instead of importing the entire library, cherry-pick the components we use.
This is [supported and encouraged](https://github.com/ReactTraining/react-router/blob/master/docs/guides/MinimizingBundleSize.md) by react-router.

Reduced the size of the main bundle by 9 KB (709 KB -> 700 KB).

* Fixing links for the contributing.md (#1738)

* a grammatical item (#1740)

* Remove state update in componentWillUpdate (#1769)

* syntatical improvements to progress bar (#1633)

* syntatical improvements to progress bar

* declare propTypes and defaultProps on the class instead of using the static keyword

* Improve the setup to recognize our own repo before clearing it. (#1720)

* Add intelligence to the setup to recognize our own repo, before nuking it. (#760, #1719)

* Cleaning up console messages upon setup

* Adding a prompt for deciding whether to clear the repo or not. Fixed: #760, #1719

* Fixing the scenario where it was not exiting this file after not removing the repository

* Doing minor changes suggested

* Updating quickstart file location (#1712)

* Request utils: handle 204 and 205 HTTP response (#1780)

* feat(core): styled-components v2 update (#1775)

* feat(core): styled-components v2 update

* fix(deps): lock version for styled plugin

* Fix: Use local instance of shelljs (#1782)

* Use local instance of shelljs

* Replace var with const

* Switching deprecated babel-preset-latest to babel-preset-env (#1736)

* adding babel-preset-env package

* replacing deprecated babel-preset-latest with babel-preset-env

to avoid the following npm installation warning:
```
npm WARN deprecated babel-preset-latest@6.24.0:
preset-latest accomplishes the same task as babel-preset-env.
Please install it with 'npm install babel-preset-env --save-dev'.
'{ "presets": ["latest"] }' to '{ "presets": ["env"] }'.
For more info, please check the docs: http://babeljs.io/docs/plugins/preset-env
```

Ref. #1667

* removing deprecated babel-preset-latest package

* Add missing word (#1789)

* Migrating from React.PropTypes to PropTypes (#1787)

* adding prop-types dependency

* migrating from React.PropTypes to PropTypes

* Adding some tests (#1784)

* tests(FeaturePage): testing shouldComponentUpdate function

* tests(HomePage): testing if username prop is missing

* tests(ProgressBar): testing when route is not changing

* tests: removing global-styles.js from coverage collect

* tests(Toggle): adding tests for empty values prop

* tests(store): adding missing tests

* tests(ProgressBar): adding missing tests

* chore(deps): update deps roll-up Jun-01-2017 (#1794)

* chore(deps): update deps roll-up Jun-01-2017

* Add react-test-renderer as dev dependency

* Remove `react-addons-test-utils`

* Use new `react-helmet` API

* Get rid of the warning: 'DeprecationWarning: loaderUtils.parseQuery() received a non-string value which can be problematic, see webpack/loader-utils#56 parseQuery() will be replaced with getOptions() in the next major version of loader-utils.'
Get rid of the warning: 'DeprecationWarning: loaderUtils.parseQuery() received a non-string value which can be problematic, see webpack/loader-utils#56 parseQuery() will be replaced with getOptions() in the next major version of loader-utils.'

* Revert line that wasn't meant to be commited

* docs(maintenance): Create dependency update doc (#1790)

* docs(maintenance): Create dependency update doc

* Update dependency.md

* Update dependency.md

* Update dependency.md

* Update dependency.md

* Add link to #598

* Update the 'tagged template literals' link to point to its new home at styled-components.com (#1824)

* feat(core): React Router v4, React-Loadable, asyncInjectors (#1746)

* Migrate to react router v4.

* Make sure Switch renders after redux state change by passing in redux location, propagate computedMatch to Route, and make not-found matcher non-exact.

* Fix route generator.

* Implicitly pass store into loader from AsyncRoute to simplify custom child route components.

* Fix route prop propagation.

* Regen yarn.lock

* Keep track of route loading in redux state and read in progress bar.

* Replace AsyncRoute with react-loadable

* Add `DefaultLoadingComponentProvider`

* Rename `loader.js` to `Loadable.js`

* Revert 9f44f1b

* small chores

* Add tests

* Update generators

* Exclude component/Loadable from coverage

* Update docs

* Make App a class that extends React.Component to enable hot reloading

* Add a link to RR4 API

* Improve generators

* Fix linting errors

* Update react-loadable

* Update yarn.lock

* Propagate InnerLoadable props to the rendered component, for Route props like match.

* Refactor

* rename withMappedState -> withConnect

* rename name to key

* Use constants

* Make 'daemon' a default mode for `injectReducer`

* Simplify `ejectSaga`

* Improve docs

* clean up

* recommend to use `ConnectedSwitch`

* turn `App` into a function like it was before

* Run CI

* Import `memoryHistory` and `browserHistory` from `react-router-dom` instead of `react-router`

* Remove path from a 'not found' route

* Update deps

* Simplify tests

* Remove modes from `injectReducer`

* Make second argument to be a descriptor in `sagaInjectors`

* Change `constants` to have consistent values

* Remove non-daemon saga descriptors in production in `ejectSaga`

* Save an entire descriptor in the saga registry

* Fix `constants` in templates

* fix(hmr): Replace `preset-hmre` with vanilla webpack HMR (#1871)

* Replace react-hmre with bare webpack hmr

* Explicitly unmount the main component

* Prevent recomputing reducers for `replaceReducer`

* Add a link to Wepack HMR to the docs

* Remove `overlay=true`

* Accept an array of modules to hot reload

* Add Debugging section in Docs + VS Code instructions (#1698)

* Add debugging section in README

* Move WebStorm FAQ to debugging section

* Add VS Code to debugging section

* Update VS Code launch config

* Update VS Code config to work in dev branch

* Add VS Code launch.json config

* Update launch.json to be compatible with master

* Update VS Code launch to be compatible with master

* Remove .vscode launch config

* Add notice on source map issue for VS Code.

* move onSubmitForm test into mapDispatchToProps test (#1644)

* Use camelcase for reducer and saga key to match selector. (#1888)

* chore(deps): remove unusable deps sinon (#1882)

* chore(deps): downgrade `sanitize.css` (#1872)

* chore(templates): turn `App` into a functional component (#1892)

Fixes #1884

* fix(generators): use correct selector names in tests and regular selectors should not be nested (#1873)

* Rename store.js to configureStore.js to Prevent conflict with storeJS… (#1904)

* Rename store.js to configureStore.js to Prevent conflict with storeJS npm package

* Fix store -> configureStore

* Bump webpack to 3.0.0 and update related deps (#1823)

* Bump webpack to 3.0.0 and related deps

* Add ModuleConcatenationPlugin to webpack base config

* Check in mysterious change in yarn.lock

* Install latest html-webpack-plugin and resolve incorrect peer dep issue

* Update webpack to 3.5.4

* Bump webpack to 3.5.5

* Move ModuleConcatenationPlugin from base to prod config, add  --display-optimization-bailout flag

* Serve Dlls via add-asset-html-webpack-plugin (#1849)

* Serve Dlls via add-asset-html-webpack-plugin

* Remove duplicate dll script tags and cheerio dependency

* Remove cheerio refs from docs

* Minor whitespace change

* Remove eslint exception in webpack.dll.babel.js

* chore(deps): Upgrade React to v15.6 (#1832)

* chore(deps): regenerate `yarn.lock` (#1931)

* chore(deps): regenerate `yarn.lock`

* Empty commit to restart netlify

* chore(3.5): Update changelog.md
Permalink
..
Failed to load latest commit information.
css Merge v3.5 release (#1929) Sep 22, 2017
general Merge v3.5 release (#1929) Sep 22, 2017
js Merge v3.5 release (#1929) Sep 22, 2017
maintenance Merge v3.5 release (#1929) Sep 22, 2017
testing Merge v3.5 release (#1929) Sep 22, 2017
README.md Merge v3.5 release (#1929) Sep 22, 2017

README.md

Documentation

Table of Contents

Overview

Quickstart

  1. First, let's kick the tyres by launching the sample Repospective app bundled with this project to demo some of its best features:

    npm run setup && npm start

  2. Open localhost:3000 to see it in action.

    • Add a Github username to see Redux and Redux Sagas in action: effortless async state updates and side effects are now yours :)
    • Edit the file at ./app/components/Header/index.js so that the text of the <Button> component reads "Features!!!"... Hot Module Reloading gives you a feedback loop with your UI so smooth it's almost conversational!
    • Click your (newly emphatic) Features button to see React Router in action... Now you can share a direct link to that content privately over your LAN or globally addressable to any device, anywhere. Not bad for a locally-running Single Page App.

  3. Time to build your own app: run

    npm run clean

    ...and use the built-in generators to start your first feature.

Development

Run npm start to see your app at localhost:3000

Building & Deploying

  1. Run npm run build, which will compile all the necessary files to the build folder.

  2. Upload the contents of the build folder to your web server's root folder.

Structure

The app/ directory contains your entire application code, including CSS, JavaScript, HTML and tests.

The rest of the folders and files only exist to make your life easier, and should not need to be touched.

(If they do have to be changed, please submit an issue!)

CSS

Utilising tagged template literals (a recent addition to JavaScript) and the power of CSS, styled-components allows you to write actual CSS code to style your components. It also removes the mapping between components and styles – using components as a low-level styling construct could not be easier!

See the CSS documentation for more information.

JS

We bundle all your clientside scripts and chunk them into several files using code splitting where possible. We then automatically optimize your code when building for production so you don't have to worry about that.

See the JS documentation for more information about the JavaScript side of things.

SEO

We use react-helmet for managing document head tags. Examples on how to write head tags can be found here.

Testing

For a thorough explanation of the testing procedure, see the testing documentation!

Browser testing

npm run start:tunnel makes your locally-running app globally available on the web via a temporary URL: great for testing on different devices, client demos, etc!

Unit testing

Unit tests live in test/ directories right next to the components being tested and are run with npm run test.