react-hackathon-board

All of these blueprints are available (and can be overridden) in the ~/blueprints folder so you can customize the
default generators for your project's specific needs. If you have an existing app you can run redux init to set up the CLI, then
make sure to copy over the blueprints folder in this project.

See the Redux CLI github repo for more information on how to create and use blueprints.

Structure
---------

The folder structure provided is only meant to serve as a guide, it is by no means prescriptive. It is something that has worked very well for me and my team, but use only what makes sense to you.

`
.
├── bin # Build/Start scripts
├── blueprints # Blueprint files for redux-cli
├── build # All build-related configuration
│ └── webpack # Environment-specific configuration files for webpack
├── config # Project configuration settings
├── interfaces # Type declarations for Flow
├── server # Koa application (uses webpack middleware)
│ └── main.js # Server application entry point
├── src # Application source code
│ ├── components # Generic React Components (generally Dumb components)
│ ├── containers # Components that provide context (e.g. Redux Provider)
│ ├── layouts # Components that dictate major page structure
│ ├── redux # Redux-specific pieces
│ │ ├── modules # Collections of reducers/constants/actions
│ │ └── utils # Redux-specific helpers
│ ├── routes # Application route definitions
│ ├── static # Static assets (not imported anywhere in source code)
│ ├── styles # Application-wide styles (generally settings)
│ ├── views # Components that live at a route
│ └── main.js # Application bootstrap and rendering
└── tests # Unit tests
`

$3

TL;DR: They're all components.

This distinction may not be important for you, but as an explanation: A Layout is something that describes an entire page structure, such as a fixed navigation, viewport, sidebar, and footer. Most applications will probably only have one layout, but keeping these components separate makes their intent clear. Views are components that live at routes, and are generally rendered within a Layout. What this ends up meaning is that, with this structure, nearly everything inside of Components ends up being a dumb component.

Webpack
-------

$3

`js
[
'history',
'react',
'react-redux',
'react-router',
'react-router-redux',
'redux',
...
]
`

$3

`js
// current file: ~/src/views/some/nested/View.js

// What used to be this:
import SomeComponent from '../../../components/SomeComponent'

// Can now be this:
import SomeComponent from 'components/SomeComponent' // Hooray!
`

$3

These are global variables available to you anywhere in your source code. If you wish to modify them, they can be found as the globals key in ~/config/_base.js. When adding new globals, also add them to ~/.eslintrc.

|Variable|Description|
|---|---|
|process.env.NODE_ENV|the active NODE_ENV when the build started|
|__DEV__|True when process.env.NODE_ENV is development|
|__PROD__|True when process.env.NODE_ENV is production|
|__TEST__|True when process.env.NODE_ENV is test|
|__DEBUG__|True when process.env.NODE_ENV is development and cli arg --no_debug is not set (npm run dev:no-debug)|
|__BASENAME__|npm history basename option|

Server
------

This app comes Koa 2 as server.

Styles
------

Both .scss and .css file extensions are supported out of the box and are configured to use CSS Modules. After being imported, styles will be processed with PostCSS for minification and autoprefixing, and will be extracted to a .css file during production builds.

NOTE: If you're importing styles from a base styles directory (useful for generic, app-wide styles), you can make use of the styles alias, e.g.:

`js
// current file: ~/src/components/some/nested/component/index.jsx
import 'styles/core.scss' // this imports ~/src/styles/core.scss
`

Furthermore, this styles directory is aliased for sass imports, which further eliminates manual directory traversing; this is especially useful for importing variables/mixins.

Here's an example:

`scss
// current file: ~/src/styles/some/nested/style.scss
// what used to be this (where base is ~/src/styles/_base.scss):
@import '../../base';

// can now be this:
@import 'base';
`

Testing
-------

To add a unit test, simply create a .spec.js file anywhere in ~/tests. Karma will pick up on these files automatically, and Mocha and Chai will be available within your test without the need to import them. If you are using redux-cli, test files should automatically be generated when you create a component or redux module (duck).

Coverage reports will be compiled to ~/coverage by default. If you wish to change what reporters are used and where reports are compiled, you can do so by modifying coverage_reporters in ~/config/_base.js.

Deployment
----------

Out of the box, this app is deployable by serving the ~/dist folder generated by npm run compile (make sure to specify your target NODE_ENV as well). This project does not concern itself with the details of server-side rendering or API structure, since that demands an opinionated structure that makes it difficult to extend the app. However, if you do need help with more advanced deployment strategies, here are a few tips:

If you are serving the application via a web server such as nginx, make sure to direct incoming routes to the root ~/dist/index.html file and let react-router take care of the rest. The Koa server that comes with the app is able to be extended to serve as an API or whatever else you need, but that's entirely up to you.


Troubleshooting
---------------

$3

This is most likely because the new window has been blocked by your popup blocker, so make sure it's disabled before trying again.

$3

Running into issues with Babel? Babel 6 can be tricky, please either report an issue or try out the [stable v0.18.1 release]

$3

By default this repo does not bundle the babel polyfill in order to reduce bundle size. If you want to include it, you can use this commit from jokeyrhyme as a reference.

$3

Make sure that your environment is installing both dependencies _and_ devDependencies, since the latter are required to build the application.

$3

While this is common to any sizable application, it's worth noting for those who may not know: if you happen to notice higher CPU usage in your editor after compiling the application, you may need to tell your editor not to process the dist folder. For example, in Sublime you can add:

`
"folder_exclude_patterns": [".svn", ".git", ".hg", "CVS", "node_modules", "dist"]
``

Thank You
---------

This project wouldn't be possible without help from the community, so I'd like to highlight some project that helped getting started. Thank you all for your hard work, you've made my life a lot easier and taught me a lot in the process.

* https://github.com/davezuko/react-redux-starter-kit

And to everyone else who has contributed, even if you are not listed here your work is appreciated.