An example universal JS application written with the 3REE stack, React + Redux + RethinkDB + Express. A stack for building apps, front and back end, with just Javascript.
This project was initially conceived to experiment with using these technologies in conjunction with one-another. I have written a blog that relates to this codebase.
This project is useful for:
- seeing how to build a Universal Javascript application
- understanding how to handle asyncronousity in Redux action creators
- seeing how you can use Socket.io with Redux
- building your own Redux powered application
- forking so that you can build your own 3REE stack app!
- Universal (Isomorphic) Javascript
- Asyncronous example
- Use of RethinkDB Changefeeds for Realtime
You will need to install RethinkDB. You can find instruction on how to do so here.
- Clone the repo
git clone git@github.com:GordyD/3ree.git
- Run
npm install
- If your local environment is not reflected by
config/default.json
, then add a file atconfig/local.json
to provide local customisation. - Run
npm run db-setup
to set up DB - Run
npm start
will start Webpack dev server - for serving the client, and also start the API server - Go to http://localhost:3001 in two seperate tabs - see changes propagate in real time (Hot Module Replacement works too)
You will need to roll out your own deployment script for a server, but before you can ship you will need to:
- Build the client with
npm run build:prod
- Ensure all production npm modules are installed on the server. e.g.
npm install --prod
- Rsync your application to your server
- Set up nginx or your web server of choice to map HTTP requests for your URL to
http://localhost:3000
- Run
npm run start:prod
to run on your server - Go to your URL
- React - view layer
- React Router - universal routing
- Redux - state management
- RethinkDB - persistance layer
- Express - server framework
- Socket.io - for realtime communication between clients and server
- Webpack - module bundling + build for client
- Superagent - universal http requests