Commit 5b8790319cab60752df4cdfea272e4b843c993cc
docs
Michael Williams committed on 12/31/2015, 6:16:32 AMParent: ec65c813463a936d2d23fcef33916e958f8d560d
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -59,4 +59,29 @@ | ||
| 59 | 59 | - test features: [cuke-tap](https://www.npmjs.com/package/cuke-tap) |
| 60 | 60 | - generators: [plop](https://github.com/amwmedia/plop) |
| 61 | 61 | |
| 62 | 62 | refs: [0](http://teropa.info/blog/2015/09/10/full-stack-redux-tutorial.html), [1](http://blog.workshape.io/the-3ree-stack-react-redux-rethinkdb-express-js/) |
| 63 | + | |
| 64 | +### micro-services | |
| 65 | + | |
| 66 | +TODO split into micro-services based on [mad-science-stack](https://github.com/enspiral-craftworks/mad-science-stack) | |
| 67 | + | |
| 68 | +TODO write docs about what is a micro-service | |
| 69 | + | |
| 70 | +### app modules | |
| 71 | + | |
| 72 | +in contrast to frameworks like Rails which split our `app` into directories for each "type" of file (models, views, controllers), our `app` is split into directories for each module, where each module contains the various types of files *within* that module. | |
| 73 | + | |
| 74 | +each module directory may contain any of: | |
| 75 | + | |
| 76 | +- `index.js`: exports all the below exports from the module | |
| 77 | +- `models/*.js`: exports [`tcomb`](https://www.npmjs.com/package/tcomb) models | |
| 78 | +- `constants.js`: exports constants (such as [redux action types](https://www.npmjs.com/package/create-action-types)) | |
| 79 | +- `actions.js`: exports [redux actions](https://www.npmjs.com/package/redux-actions) | |
| 80 | +- `reducer.js`: exports [redux reducer](http://redux.js.org/docs/basics/Reducers.html) | |
| 81 | +- `routes.js`: exports [`function (store) { return <ReactRouter.Route /> }`](https://www.npmjs.com/package/react-router) | |
| 82 | +- `getters.js`: exports [`reselect`](https://www.npmjs.com/package/reselect) getters for use in containers' `connect` | |
| 83 | +- `containers/*.js`: exports [smart component](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0) [`connect`](https://github.com/rackt/react-redux/blob/master/docs/api.md#connectmapstatetoprops-mapdispatchtoprops-mergeprops-options)ed with [`react-redux`](https://www.npmjs.com/package/react-redux) | |
| 84 | +- `components/*.js`: exports [dumb component](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0) | |
| 85 | +- `components/*.css`: exports [css modules](http://glenmaddern.com/articles/css-modules) for respective component | |
| 86 | +- `service.js`: exports [`feathers`](http://feathersjs.com) service (recommended to use [`feathers-knex`](https://github.com/feathersjs/feathers-knex) and [`feathers-tcomb`](https://github.com/ahdinosaur/feathers-tcomb)) | |
| 87 | +- `client.js`: exports [`feathers-client`](https://github.com/feathersjs/feathers-client) | |
Built with git-ssb-web