1 | # @immowelt/eslint-config-immowelt-react
|
2 |
|
3 | [![Powered by Immowelt](https://img.shields.io/badge/powered%20by-immowelt-yellow.svg?colorB=ffb200)](https://stackshare.io/immowelt-group/)
|
4 | [![Greenkeeper badge](https://badges.greenkeeper.io/ImmoweltGroup/eslint-config-immowelt-react.svg)](https://greenkeeper.io/)
|
5 | [![Build Status](https://travis-ci.org/ImmoweltGroup/eslint-config-immowelt-react.svg?branch=master)](https://travis-ci.org/ImmoweltGroup/eslint-config-immowelt-react)
|
6 | [![Dependency Status](https://david-dm.org/ImmoweltGroup/eslint-config-immowelt-react.svg)](https://david-dm.org/ImmoweltGroup/eslint-config-immowelt-react)
|
7 | [![devDependency Status](https://david-dm.org/ImmoweltGroup/eslint-config-immowelt-react/dev-status.svg)](https://david-dm.org/ImmoweltGroup/eslint-config-immowelt-react#info=devDependencies&view=table)
|
8 |
|
9 | This package servers as the basis for the JavaScript standards of the Immowelt GmbH.
|
10 |
|
11 | It sets a bunch of rules and warnings for best practices on how to write a maintainable JavaScript code base, as well as hints on how to write a good performing React application.
|
12 |
|
13 | ## Usage
|
14 | If you want to use the `@immowelt/eslint-config-immowelt-react` config, you can install it by executing:
|
15 | ```bash
|
16 | npm i -D @immowelt/eslint-config-immowelt-react
|
17 | ```
|
18 |
|
19 | Then create a file named `.eslintrc` with following contents in the root folder of your project:
|
20 |
|
21 | ```json
|
22 | {
|
23 | "extends": "@immowelt/eslint-config-immowelt-react"
|
24 | }
|
25 | ```
|
26 |
|
27 | ## License
|
28 | See the `LICENSE` file at the root of the repository.
|