Closed thejmazz closed 7 years ago
That's a pretty good summary, thanks :+1: @EricSimons think we might be able to use this or something like it somewhere?
Definitely! Thanks for this @thejmazz -- I'm going to put this in the readme later today & will attribute you :)
Hey @EricSimons, don't mean to bother, but it has been a little over a week and I don't think the readme has been updated!
Really good content to start some Wiki for this repo
Totally - was just thinking about this today. Been tied with the main RealWorld project lately, but I'd be down to make this happen over the weekend 👍 On Fri, Apr 28, 2017 at 2:57 AM Denis Kiselev notifications@github.com wrote:
Really good content to start some Wiki for this repo
— You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub https://github.com/gothinkster/react-redux-realworld-example-app/issues/28#issuecomment-297933792, or mute the thread https://github.com/notifications/unsubscribe-auth/AAh_hq3ckf2RyOClHDpdAy1A6guyioB0ks5r0Zv4gaJpZM4KvGlb .
-- Sent from my iPhone
@thejmazz your work is now powering the readme :) thanks again for your help!
Just looking for some place to put these.
I think understanding patterns/idioms is more important than reading a codebase, so I tried to extract all that I could find in this project. As well some of my own ideas snuck a little in (e.g. thinking of how to integrate Flow), Would like feedback on anything missed, ideally this describes how everything works in the project.
Enjoy:
React-Redux App
Entrypoint
File:
index.js
Imports:
agent.js
,store.js
,./components/*
Renders routes pointing to their associated components:
Agent
File:
agent.js
Exports an object where each key is a "service" and a service has methods that internally run a request:
get
put
post
delete
For example,
Auth
:Thus, these services essentially take some options, map to a request, and return the promise of that request. The general type could be:
As well,
agent.js
locally stores a token which can be set via the exportedsetToken
. As some config there isAPI_ROOT
.Redux
Store
File:
store.js
Imports:
reducer.js
,middleware.js
Fairly simple store setup, applies
promiseMiddleware
beforelocalStorageMiddleware
, logger only on development.Middleware
File:
middleware.js
Imports:
agent.js
promiseMiddleware
Intercepts all actions where
action.payload
is a Promise. In which case it:store.dispatch({ type: 'ASYNC_START', subtype: action.type })
action.payload.then
store.dispatch({ type: 'ASYNC_END', promise: res })
action.error = true
,store.dispatch({ type: 'ASYNC_END', promise: action.payload })
action
object:store.dispatch(action)
localStorageMiddleware
Runs after
promiseMiddleware
. InterceptsREGISTER | LOGIN
and eitheragent.setToken(token)
''
and doesagent.setToken(null)
Reducers
File:
reducer.js
Imports:
./reducers/*.js
Uses
combineReducers
to export a reducer where each key is the reducer of the file with the same key.General Reducer Patterns
ASYNC_START
andaction.subtype
action.errors
if it is there (see middleware)componentWillReceiveProps
somewhere)Components
Most
mapStateToProps
won't be mentionned, as there are fairly simple. Take some objects, use them in render.mapDispatchToProps
will be referred to as "handlers". Some will emerge as common ones. Dispatching some specific handlers on some specific lifecylce methods will also emerge as a pattern.Handlers:
onLoad
onUnload
onSubmit
onClick
onX
onLoad
seems to be the most common one, used for any components that need ajax in data into store into props into their render method (which is basically everything on an SPA lol).Patterns
onLoad
handlers pass a Promise or multiple promises viaPromise.all
payload[0]
andpayload[1]
in reducer (seereducers/article.js
)pass a handler, e.g.
onClickTag
as a prop to a child component. child component then calls it with agent:props.onClickTag(tag, agent.Articles.byTag(tag))
. (does this only ever happen with a connectedindex.jsx
inside a folder?)to render or not to render:
componentWillReceiveProps
to call handlers if necessary, e.g. inEditor.js
:Root Component - "/"
Imported components:
Header
Handlers
onLoad: (payload, token) => dispatch({ type: 'APP_LOAD', payload, token, skipTracking: true })
onRedirect: () => dispatch({ type: 'REDIRECT' })
Lifecycle
Home Component - "/"
(
<IndexRoute>
on "/")Handlers
Lifecycle
Other Components
Should be self explanatory, follow patterns described above, it was just the home and index components are somewhat unique due to handling of routing.