@boehringer-ingelheim/create-config/README.md

Add shared configs to your project.

# create-config

This project helps you getting started and using the Boehringer Ingelheim shared config files.

It is based on a script, that sets up shared config files and packages.

Please also check out other projects that deal with shared configurations such as for [prettier](https://github.com/Boehringer-Ingelheim/prettier-config) or [eslint](https://github.com/Boehringer-Ingelheim/eslint-config).

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://github.com/boehringer-ingelheim/create-config/blob/main/LICENSE)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/boehringer-ingelheim/create-config/graphs/commit-activity)

## Prerequisites

- node (version 16 or higher recommended) is installed (use nvm to manage different node versions)

## Usage

To use this utility, start with one of the following commands and follow the prompts.

```sh
# with npm
npm init @boehringer-ingelheim/config
# or
npm create @boehringer-ingelheim/config

# with yarn
yarn create @boehringer-ingelheim/config
```

## Files (examples)

- editorconfig
- settings.json (VSCode)
- eslintrc.cjs
- prettierrc.cjs
- ...

## Packages (examples)

- eslint
- prettier
- ...

## Attribution

This project is heavily inspired by [create-vite](https://npmjs.com/package/create-vite).

## Show your support

Give a ⭐️ if this project helped you!

## License

Copyright © 2023 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).  
This project is [MIT](https://github.com/boehringer-ingelheim/create-config/blob/main/LICENSE) licensed.

## Resources

- <https://conventionalcommits.org/en/v1.0.0/>
- <https://semantic-release.gitbook.io/>
- <https://semver.org/>