Better documentation

[mxstbr]

• Files
• Explanation of the possible npm commands
• Testing
  • How to write unit tests
    • Mocha
    • expect
    • Real world usage
      • Reducers
      • rewire
      • Actions
  • How to write good unit tests (see this article and this response for inspo)
  • How to write component tests
    • Shallow rendering
    • enzyme
  • Browser testing
    • npm run serve
• Explanation of the main design decisions behind this boilerplate (maybe incomplete)
  • User side
    • JS
      • ESNext Features (see Document use of experimental syntax (e.g stage-0, stage-1) #165)
      • ImmutableJS
      • React
        • react-router
        • Components/Containers split (see Make components stateless #33, this article)
        • Redux
          • reselect (see Add memoized selector example with reselect #61)
          • redux-simple-router
          • redux-saga
      • eslint
        • Airbnb style
      • FontFaceObserver
    • CSS
      • CSS Modules
      • sanitize.css
      • PostCSS
        • cssnext
        • autoprefixer
        • postcss-focus
        • cssnano
    • Offline First
      • ServiceWorker
      • AppCache
  • Developer side
    • Webpack
    • Babel
    • Beginner
      • Modules (export and import)
      • Prerequisites
        • node
          • npm
        • git
• FAQs
  • nodejs-legacy for linux (see here)
  • Error: listen EADDRINUSE 127.0.0.1:3000
  • Hot-reloading doesn't work?
  • Why do I need this?
  • Can I use Sass with this?
  • I don't want to use Redux!
• Gotchas
  • Images in the HTML file (Copy and past from README)
• Advanced Patterns
  • Ducks (see Application Structure #27)
  • ryanflorences non-flat app structure (see Application Structure #27)
• Deployment guides
  • scp
  • Heroku
  • Codeship
  • Beanstalk

Legend: Cursive todos are nice-to-haves, but only to be done when everything else is done, and bold todos are must-haves before releasing

Note: If you're planning on writing one of these sections, please be sure to talk about the v3.0.0 branch and to submit your PR against the v3.0.0 branch!

[swastik]

ember-cli has a great user guide for some reference: http://ember-cli.com/user-guide/

[mxstbr]

More documentation inspo: https://github.com/coryhouse/react-slingshot

[mxstbr]

Nice webpack how-to for beginners by @petehunt:

https://github.com/petehunt/webpack-howto/blob/master/README.md

[mxstbr]

Document protected master branch. (See #72)

[mxstbr]

More documentation inspo: https://github.com/davezuko/react-redux-starter-kit

[mxstbr]

Amazing documentation for beginners by @lewiscowper https://github.com/lewiscowper/visualising-npm which we're allowed to steal

[mxstbr]

Design decisions inspiration: https://github.com/reactuate/reactuate

[mxstbr]

I'll close this issue as most of this points are touched upon, and will open specific issues for points we still need to touch.

[christopherdiehl]

A beanstalk/ AWS or Docker deployment guide would be very helpful.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.