Skip to content

Commit

Permalink
Add docs README (redfin#328)
Browse files Browse the repository at this point in the history
  • Loading branch information
doug-wade authored and davidalber committed Jul 24, 2016
1 parent 603b0c7 commit 48db1c5
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# React Server docs

Welcome to the React Server docs! React Server assumes a separate back end
server to serve a JSON api that it can call to get its data, and is a
bring-your-own Flux implementation stack. At Redfin, we use
[Spring MVC](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html)
and [Reflux](https://github.com/reflux/refluxjs), respectively, but it shouldn't
matter what technology you chose for either. Choosing a tech stack is out of
scope for our documentation, but come swing by our gitter if you'd like to talk
about it.

If you still aren't convinced on React Server, check out our
[Why React Server](/why-react-server.md) doc, which explains why you might want
to use React Server, and the [Design Doc](/design.md), which explains why we
built React Server and some of the decisions we made along the way.

To get started working with a new React Server project, you'll probably want to
check out the [Writing pages guide](/writing-pages.md) first, which details how
to create a new web page in a React Server app. You'll also want to check out
the [Page API](/page-api.md), and you may want to also check out
[Writing Middleware](/writing-middleware.md), which explains how to write code
that runs for every route.

To dig deeper into understanding React Server, you may want to learn about
[how logging works](/logging.md), [client transitions](/client-transitions.md),
and [understanding rendering](/understanding-rendering.md).

0 comments on commit 48db1c5

Please sign in to comment.