npm package: @sigma-force/react-sigma-cli
Description: @sigma-force/react-sigma-cli is a framework for React that allows you to take this library to another level, integrate the best practices in the industry into your projects.
Author: Sigma-Force Team
Latest version: 3.0.8

# @sigma-force/react-sigma-cli

**react-sigma-cli** is a framework for **React** that allows you to take this library to another level, integrate the best practices in the industry into your projects.

_You have the idea, **react-sigma-cli** accompanies you to create it_

## Why use `react-sigma-cli`?

By implementing `react-sigma-cli` in your project will be have:

- Installation optimized for removing unnecessary code.
- @react/cli organizes your project in a modular structure, generating a more consistent and ordered code
- Having a highly modularized structure allows you to better distribute the work with your development team
- @react/cli has a package of dependencies that have been verified and tested to offer you a complete and stable development environment
- The way @react/cli organizes your project allows you to have greater productivity when creating code and easier maintenance.
- Easier to run unit tests

## Prerequisites

Before you start using **react-sigma-cli** you must have installed:

- `NodeJS Version 12.16.1` or higher
- `npm Version 6.14.4` or higher


## Getting Started

### Installation

The dependency `@sigma-force/react-sigma-cli` must be installed globally. 

    npm install -g @sigma-force/react-sigma-cli

**Note:** if you require administrative permission use `sudo` for your installation
 
	sudo npm install -g @sigma-force/react-sigma-cli


### Start new project

1. Run in the terminal 

		react-sigma-cli

2. Insert the name of the project

![start react-sigma-cli](./.readme-static/start-cli.png) 


### scripts

For start in **developer** mode run in the terminal

	npm run start

For create a bundle for production, run the next comand

	npm run build

To check the code for formatting problems use

	npm run format

To automatically fix formatting problems use

	npm run lint

### Uninstall

	npm uninstall -g @sigma-force/react-sigma-cli

## Documentation

You can find the Kaizen Web Client documentation [on Notion](https://www.notion.so/rulocode/React-cli-7cb832838b334971a37f8b2b8ed9d17e).

The documentation is divided into several sections:

* [Requirements](https://www.notion.so/rulocode/Requirements-75bb9d70b2b94d2abe1070756025a483)

* [Code](https://react-sigma-cli-doc.now.sh/)




## Authors

<p style='margin-bottom:15px;'>
	<a href='https://github.com/jeff-js' target='_blank'>
		<img class="avatar" src="https://avatars2.githubusercontent.com/u/5813240?s=96&v=4" width="48" height="48" alt="@jeff-js">
		Jefferson Aguilar
	</a>
</p>
<p style='margin-bottom:15px;'>
	<a href='https://github.com/cosmosoftroot' target='_blank'>
		<img class="avatar" src="https://avatars1.githubusercontent.com/u/28010872?s=96&amp;v=4" width="48" height="48" alt="@cosmosoftroot">
		Iván Darío Sánchez
	</a>
</p>
<p style='margin-bottom:15px;'>
	<a href='https://github.com/wilson-romero' target='_blank'>
		<img class="avatar" src="https://avatars2.githubusercontent.com/u/55015479?s=96&v=4" width="48" height="48" alt="@wilson-romero">
		Wilson Romero
	</a>
</p>
<div style='margin-bottom:15px;'>
	<a href='https://github.com/rulo-code' target='_blank'>
		<img class="avatar" src="https://avatars3.githubusercontent.com/u/48034545?s=96&v=4" width="48" height="48" alt="@rulo-code">
		Andrés Santana
	</a>
</div>


## Contributing

Thank you for being here, we're really happy you decided to contribute to the project.

Before you contribute to the project please make sure to read all items below.

* [Contributing Guide](/CONTRIBUTING.md)


## Sponsors

<a href='https://platzi.com/' target='_blank'>
	<img src='https://static.platzi.com/media/avatars/Platzi-f730e65b-e92b-44d3-81c0-5c59c4dc4658.png' alt='Platzi' width='70px' />
</a>

## License

MIT License - Copyright (c) 2020 Σ SIGMA Force