Boilerplate for react based on babel, webpack, redux, jest, jsdoc and hotreload

This project include scaffolding, test, doc code, style configuration to use in any case

It is not based on create-react-app

Setup

These are the instructions to setup this boilerplate. You can add your own configurations and stuff for your own purpose.

*** Please feel free to add pull request for any issue, suggestion or feature

Prev-Steps

* Install your favorite editor, in this time i'm used [VSCode ^1.27.2](https://code.visualstudio.com/)
* Install [Nodejs](https://nodejs.org/es/)
* Install [GIT](https://git-scm.com/)
* Configure Code Formatter. Read airbnb eslint format rules
* Install vscode prettier plugin in roder to align your editor with the airbnb eslint rules

Installation

Clone the repository

https://github.com/clenondavis/react-boilerplate.git

Once you downloaded the repo, install the npm dependencies executing the following command

npm i

Test

This include jest as main test environment.

Branches

The branches alignment will be based on gitflow naming. Before you create a branch be sure the pull the latest change from dev branch.

For any attemp changes to this repo, please use PR (Pull Request) as your request change.

development environment

For any development please checkout dev branch. Do not work on master branch.

Branches schema naming

In this section you will see the naming schema for:

• feature/
• bugfix/
• hotfix/
• spike/

Create any branches schema from dev branch. Use - as your word devider Use lowercase format in the branching naming

Feature/

The naming to use in order to create a feature branch is feature/short-title-of-the-feature

Bugfix/

The bugfix exist beside dev branch. The naming to use in order to create a feature branch is bugfix/short-title-of-the-bugfix

hotfix/

The bugfix exist beside master branch. The naming to use in order to create a feature branch is bugfix/short-title-of-the-bugfix

spike/

This branch will allow any proposal feature or lib. The naming to use in order to create a feature branch is spike/short-title-of-the-spike-proposal

Code Documentation

This include jsDoc as main code documentator environment.

Developed with

• Reactjs main lib core
• babel - Transpiler ES5/Es6
• redux - State flow flux implementation
• webpack - Bundler
• jest - Testing tool
• jsdoc - Code documentation context
• airbnb-eslinter - Code rules practice watcher

Contributtors

• This readme template is forked from Billie Thompson

Colaborator

Your contribution are important. If you want to become and colaborator just follow next steps:

• Star the project
• Follow the project to receive notifications of changes
• Fork and add PR to push changes
• get in contact with clenondavis

You can be a colaborator for other community like Nicaragua community JsNi

• get in touch with me

Changes Coming Soon

This boilerplate will include:

• Implementation of npm publish configuration
• Redux log monitor for store
• Code spliting practice implementation
• CLI for multiple stack choice implementation

Authors

• Carlos Lenon - Be fun - clenondavis

License

This project is based on MIT license - ver see license detail MIT

Inspiration

• Share code to community
• On road to be a Full Stack Javscript Developer
• Learns More
• Learn from you