Skip to content

kocisov/wooo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wooo Build Status npm davidm Code Climate

Tool that helps you add Redux to your React project without pain

Main goal of wooo

Let users write one command instead of creating 5 folders, 10+ files and installing 4 dependencies for Redux to get going.

So, what does wooo do?

Wooo does install required dependencies and create template files in specified path with:

  1. One duck module for user login/logout
  2. One stateless Component with CSS
  3. React-router and react-router-redux reducer (You can choose v4 or v3 (default) template)
  4. Redux store configuration for production and development by process.env.NODE_ENV check
  5. One Container with connected props by connect() function

This is pretty much just fast scaffolding, not actual code! But it can be edited to be production-ready with few more lines.

Installation

Node version 6 or higher is required!

# with yarn
$ yarn global add redux-wooo

# with npm
$ npm install -g redux-wooo

Usage

wooo [options]
  --help, -h                Show Wooo's usage.
  --version, -v             Show Wooo's version.
  --template, -t [name]     Specify which template should Wooo create (templates directory)
  --npm, -n                 Use npm for installing dependencies. (Wooo uses Yarn by default)
  --dir, -d [path]          Directory, where do you want to create files by Wooo. (Dependencies are written into package.json (yarn creates new package.json if it is not present) in current directory)

Default path for files is src folder in your current location in command line!

Contribution

If you want to add template, just fork the repo and add your template files in folder into /template.

This is not ideal and in the future Wooo will have better system for this.