vilmarcabanero/my-react-boilerplate-ts

React Boilerplate based on the react-boilerplate-cra-template.

How to use this boilerplate.

⚠️ Using Yarn Package Manager is recommended over npm.

1. Clone the app.

git clone https://github.com/vilmarcabanero/my-react-boilerplate-ts.git my-app

2. Go the the app then install the packages.

cd my-app
yarn

3. Rename your package.json > "name" from my-react-boilerplate-ts to my-app.

Features

1. Uses Material UI, Redux Saga, Redux Toolkit.

2. Has generators for child component, component, container, slice and function generator. Use yarn generate to start.

3. Scalable code structure.

Plop generator

To use the generator, run

yarn generate

For contributors

Commit message format

git commit -m "<JIRA_TICKET>: <COMMIT_MESSAGE>"

For example,

git commit -m "CB-1: Fix the type of children props."

Creating new branch format

Checkout from the dev branch, then create a new branch.

git checkout -b "<TYPE>/<JIRA_TICKET>/<BRANCH_NAME>"

Where TYPE would be feature or bugfix, and BRANCH_NAME would be a short-description-of-ticket
For example,

git checkout -b "feature/CB-1/login-feature"

Contributors

Vilmar Cabañero 💻

Virna Cabaguing 💻