react-lte/README.md

AdminLTE v3 template for ReactJS

# `react-lte` - AdminLTE v3 template for ReactJS

[![License](https://img.shields.io/github/license/pattisahusiwa/react-lte)](https://github.com/pattisahusiwa/react-lte/blob/master/LICENSE)
[![gh-pages](https://img.shields.io/github/workflow/status/pattisahusiwa/react-lte/gh-pages%20deploy?label=gh-pages)](https://github.com/pattisahusiwa/react-lte/actions?query=workflow%3A%22gh-pages+deploy%22)

[![](https://img.shields.io/github/package-json/dependency-version/pattisahusiwa/react-lte/react)]()
[![](https://img.shields.io/github/package-json/dependency-version/pattisahusiwa/react-lte/admin-lte)]()
[![](https://img.shields.io/github/package-json/dependency-version/pattisahusiwa/react-lte/bootstrap)]()
[![](https://img.shields.io/github/package-json/dependency-version/pattisahusiwa/react-lte/reactstrap)]()

- [`react-lte` - AdminLTE v3 template for ReactJS](#react-lte---adminlte-v3-template-for-reactjs)
  - [Demo](#demo)
  - [Installation](#installation)
    - [Install with `npm`](#install-with-npm)
    - [Install with `yarn`](#install-with-yarn)
    - [Install with `pnpm`](#install-with-pnpm)
  - [Changelog](#changelog)
  - [Contributing](#contributing)
    - [Prerequisite](#prerequisite)
    - [How to contribute](#how-to-contribute)
  - [License](#license)

## Demo
Visit https://pattisahusiwa.github.io/react-lte to see the live demo.

## Installation
You can add this package to your project by using `npm`, `yarn`, or `pnpm`.

### Install with `npm`
````bash
npm add react-lte --save
````

### Install with `yarn`
````bash
yarn add react-lte
````

### Install with `pnpm`
````bash
pnpm add react-lte
````

## Changelog
See [CHANGELOG.md](https://github.com/pattisahusiwa/react-lte/blob/master/CHANGELOG.md)


## Contributing
All form of contributions are welcome. You can [report issues](https://github.com/pattisahusiwa/react-lte/issues), [request new feature](https://github.com/pattisahusiwa/react-lte/issues),  fork the repo and [submit pull request](https://github.com/pattisahusiwa/react-lte/pulls).

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

### Prerequisite

This repository uses 2 global packages which should be installed first:
1. `pnpm` as a package manager. Please [check this page](https://pnpm.js.org/en/installation) to learn how to install the tool.
2. `eslint`.


### How to contribute
1. Fork and clone the repository,
2. Install package dependencies
    ````bash
    pnpm install
    ````
3. Create a new git branch,
4. Make a necessary change, add unit test, commit, and submit PR.
5. All submitted code should not have linter issues.

## License
This project is released under [MIT](https://opensource.org/licenses/MIT) license.
See [LICENSE](https://github.com/pattisahusiwa/react-lte/blob/master/LICENSE) file for more details.

For the original AdminLTE license, see [AdminLTE license](https://github.com/ColorlibHQ/AdminLTE/blob/master/LICENSE).