@apolitical/eslint-config/README.md

Apolitical ESLint and Prettier configurations for Node projects

# Apolitical Eslint Config

Apolitical ESLint and Prettier configurations for Node projects 

## Requirements

Requires the following to run:

- [node.js][node] 16.13.0+
- [yarn][yarn]

[node]: https://nodejs.org/en/download/
[yarn]: https://classic.yarnpkg.com/en/docs/install

## Installation

Install with `yarn`:

```sh
yarn add -D @apolitical/eslint-config
```

## Usage

Link the ESLint configurations from your `package.json`:

On your API (Express project):
```json
  "eslintConfig": {
    "extends": "@apolitical/eslint-config/api.config"
  },
```

On your UI (React project):
```json
  "eslintConfig": {
    "extends": "@apolitical/eslint-config/ui.config"
  }
```

Link the Prettier configurations from your `package.json`:

```json
  "prettier": "@apolitical/eslint-config/prettier.config"
```