compie/readme.md

CLI tool that scaffolds React components.

# compie


<a href="https://raw.githubusercontent.com/jaid/compie/master/license.txt"><img src="https://img.shields.io/github/license/jaid/compie?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor compie"/></a>  
<a href="https://actions-badge.atrox.dev/jaid/compie/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fcompie%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/compie/commits"><img src="https://img.shields.io/github/commits-since/jaid/compie/v3.0.0?style=flat-square&logo=github" alt="Commits since v3.0.0"/></a> <a href="https://github.com/jaid/compie/commits"><img src="https://img.shields.io/github/last-commit/jaid/compie?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/compie/issues"><img src="https://img.shields.io/github/issues/jaid/compie?style=flat-square&logo=github" alt="Issues"/></a>  
<a href="https://npmjs.com/package/compie"><img src="https://img.shields.io/npm/v/compie?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/compie/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/compie?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/compie"><img src="https://img.shields.io/npm/dm/compie?style=flat-square&logo=npm" alt="Downloads"/></a>

**CLI tool that scaffolds React components.**





## Installation

<a href="https://npmjs.com/package/compie"><img src="https://img.shields.io/badge/npm-compie-C23039?style=flat-square&logo=npm" alt="compie on npm"/></a>

```bash
npm install --global compie@^3.0.0
```

<a href="https://yarnpkg.com/package/compie"><img src="https://img.shields.io/badge/Yarn-compie-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="compie on Yarn"/></a>

```bash
yarn global add compie@^3.0.0
```

<a href="https://github.com/jaid/compie/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/compie-24282e?style=flat-square&logo=github" alt="@jaid/compie on GitHub Packages"/></a>  
(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))

```bash
npm install --global @jaid/compie@^3.0.0
```












## CLI Usage
After installing package `compie` globally, you can use its command line interface.
```bash
compie
```
For usage instructions:
```bash
compie --help
```




## Development



Setting up:
```bash
git clone git@github.com:jaid/compie.git
cd compie
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```


## License
[MIT License](https://raw.githubusercontent.com/jaid/compie/master/license.txt)  
Copyright © 2020, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)