reactux

4.0.3 • Public • Published

reactux

Ready-to-go template for React + Redux + Express App

Installation

npm install -g reactux

Usage

reactux [project name]
// this will create a folder [project name] contains the template in current directory

Template Features

  • CLI to generate start files
  • Fully support ES6
  • Dev and Production environment setting
  • Bundle with webpack 2 with js, css, postcss, and file loaders
  • Reasonable file structure for both Frontend and Backend
  • React Router v4 support
  • Built-in Redux dev tools and middlewares
  • Express server with customization and configuration including auth, logger, cor
  • Tests Setup with Jest
  • eslint built-in with customized configuration
  • Option to sync Redux store with LocalStorage
  • Deploy with pm2

Project Stucture

Frontend

  • /src/react
    • action -> action creators in redux
    • components -> reusable components
    • constants -> const
    • containers -> parent components
    • reducers -> redux reducers
    • configureStore.js -> redux store setup
    • index.html -> html template
    • index.js -> entry point
    • localStorage.js -> setup sync between redux store and localStorage

Backend

  • /src/server
    • config -> server config like environment and database
    • middleware -> custom express middleware
    • models -> model used in database
    • routes -> routes setup
    • app.js -> main server app
    • index.js -> entry point

Run Dev Server

webpack will move and compile src/react into dist/react and use babel-node to run express server

Run Production Server

webpack will move and compile src/react and src/server into build/react and build/server and use node to run express server

Development

cd [your project]
yarn install // or npm install
yarn dev // or npm run dev

Test

yarn test // or npm run test

Linting

yarn lint // or npm run lin

Production

yarn install
yarn production

Deploy with PM2

yarn install
yarn production

License

Copyright (c) 2017 Haochuan Licensed under the MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i reactux

Weekly Downloads

6

Version

4.0.3

License

MIT

Last publish

Collaborators

  • haochuan